api

Documentation

Index

• Constants
• Variables
• func ErrorCode(err error) string
• func ErrorData(err error) string
• func ErrorDebugInfo(err error) string
• func ErrorMessage(err error) string
• func ErrorStatusCode(code string) int
• func PrintableSecret(secret string) string
• func WriteError(c echo.Context, err error) error
• func WriteSuccess(c echo.Context, payload any) error
• type Config
  • func NewConfig(connection string) Config
  • func (c Config) GetUsername() string
  • func (t *Config) Migrate() bool
  • func (c Config) ReadEnv() Config
  • func (c Config) String() string
• type Error
  • func Errorf(code string, format string, args ...any) *Error
  • func FromError(err error) *Error
  • func (e *Error) Error() string
  • func (e *Error) WithData(data any) *Error
  • func (e *Error) WithDebugInfo(msg string, args ...any) *Error
• type HTTPError
  • func HTTPErrorFromErr(err error) *HTTPError
  • func (e *HTTPError) Error() string
• type HTTPSuccess
• type MigrationMode
• type PostgrestConfig
  • func (p PostgrestConfig) ReadEnv() PostgrestConfig
  • func (p PostgrestConfig) String() string

Constants

const (
	ECONFLICT       = "conflict"
	EFORBIDDEN      = "forbidden"
	EINTERNAL       = "internal"
	EINVALID        = "invalid"
	ENOTFOUND       = "not_found"
	ENOTIMPLEMENTED = "not_implemented"
	EUNAUTHORIZED   = "unauthorized"
)

Application error codes.

These are meant to be generic and they map well to HTTP error codes.

Variables

var DefaultConfig = Config{
	Postgrest: PostgrestConfig{
		Version:    "v10.0.0",
		DBRole:     "postgrest_api",
		AnonDBRole: "",
		Port:       3000,
		AdminPort:  3001,
		MaxRows:    2000,
	},
}

Functions

func ErrorCode

func ErrorCode(err error) string

ErrorCode unwraps an application error and returns its code. Non-application errors always return EINTERNAL.

func ErrorData

func ErrorData(err error) string

ErrorMessage unwraps an application error and returns its message. Non-application errors always return "Internal error".

func ErrorDebugInfo

func ErrorDebugInfo(err error) string

ErrorDebugInfo unwraps an application error and returns its debug message.

func ErrorMessage

func ErrorMessage(err error) string

ErrorMessage unwraps an application error and returns its message. Non-application errors always return "Internal error".

func ErrorStatusCode

func ErrorStatusCode(code string) int

ErrorStatusCode returns the associated HTTP status code for an application error code.

func PrintableSecret

func PrintableSecret(secret string) string

func WriteError

func WriteError(c echo.Context, err error) error

func WriteSuccess

func WriteSuccess(c echo.Context, payload any) error

Types

type Config

type Config struct {
	Metrics                  bool
	ConnectionString, Schema string
	DisableKubernetes        bool
	Namespace                string
	Postgrest                PostgrestConfig
	LogLevel                 string
	LogName                  string

	RunMigrations      bool
	SkipMigrations     bool
	SkipMigrationFiles []string
	MigrationMode      MigrationMode
}

func NewConfig

func NewConfig(connection string) Config

func (Config) GetUsername

func (c Config) GetUsername() string

func (*Config) Migrate

func (t *Config) Migrate() bool

func (Config) ReadEnv

func (c Config) ReadEnv() Config

func (Config) String

func (c Config) String() string

type Error

type Error struct {
	// Machine-readable error code.
	Code string

	// Human-readable error message.
	Message string

	// Machine-machine error message.
	Data string

	// DebugInfo contains low-level internal error details that should only be logged.
	// End-users should never see this.
	DebugInfo string
}

Error represents an application-specific error.

func Errorf

func Errorf(code string, format string, args ...any) *Error

Errorf is a helper function to return an Error with a given code and formatted message.

func FromError

func FromError(err error) *Error

func (*Error) Error

func (e *Error) Error() string

Error implements the error interface. Not used by the application otherwise.

func (*Error) WithData

func (e *Error) WithData(data any) *Error

WithData sets the given data

func (*Error) WithDebugInfo

func (e *Error) WithDebugInfo(msg string, args ...any) *Error

WithDebugInfo wraps an application error with a debug message.

type HTTPError

type HTTPError struct {
	Err     string `json:"error"`
	Message string `json:"message,omitempty"`

	// Data for machine-machine communication.
	// usually contains a JSON data.
	Data string `json:"data,omitempty"`
}

func HTTPErrorFromErr

func HTTPErrorFromErr(err error) *HTTPError

func (*HTTPError) Error

func (e *HTTPError) Error() string

Error implements the error interface. Not used by the application otherwise.

type HTTPSuccess

type HTTPSuccess struct {
	Message string `json:"message"`
	Payload any    `json:"payload,omitempty"`
}

type MigrationMode

type MigrationMode int

const (
	RunByDefault MigrationMode = iota
	SkipByDefault
)

type PostgrestConfig

type PostgrestConfig struct {
	Port       int
	Disable    bool
	LogLevel   string
	URL        string
	Version    string
	JWTSecret  string
	DBRole     string
	AnonDBRole string
	AdminPort  int

	// A hard limit to the number of rows PostgREST will fetch from a view, table, or stored procedure.
	// Limits payload size for accidental or malicious requests.
	MaxRows int
}

func (PostgrestConfig) ReadEnv

func (p PostgrestConfig) ReadEnv() PostgrestConfig

func (PostgrestConfig) String

func (p PostgrestConfig) String() string