local

Documentation

Index

• Constants
• func IsProjectInit(projectPath string) bool
• type App
  • func NewApp(ctx context.Context, opts *AppOptions) (*App, error)
  • func (a *App) Close() error
  • func (a *App) Serve(httpPort, grpcPort int, enableUI, openBrowser, readonly bool, ...) error
• type AppOptions
• type LogFormat
  • func ParseLogFormat(format string) (LogFormat, bool)
• type Server
  • func (s *Server) DeployProject(ctx context.Context, r *connect.Request[localv1.DeployProjectRequest]) (*connect.Response[localv1.DeployProjectResponse], error)
  • func (s *Server) DeployValidation(ctx context.Context, r *connect.Request[localv1.DeployValidationRequest]) (*connect.Response[localv1.DeployValidationResponse], error)
  • func (s *Server) GetCurrentUser(ctx context.Context, r *connect.Request[localv1.GetCurrentUserRequest]) (*connect.Response[localv1.GetCurrentUserResponse], error)
  • func (s *Server) GetMetadata(ctx context.Context, r *connect.Request[localv1.GetMetadataRequest]) (*connect.Response[localv1.GetMetadataResponse], error)
  • func (s *Server) GetVersion(ctx context.Context, r *connect.Request[localv1.GetVersionRequest]) (*connect.Response[localv1.GetVersionResponse], error)
  • func (s *Server) Ping(ctx context.Context, r *connect.Request[localv1.PingRequest]) (*connect.Response[localv1.PingResponse], error)
  • func (s *Server) PushToGithub(ctx context.Context, r *connect.Request[localv1.PushToGithubRequest]) (*connect.Response[localv1.PushToGithubResponse], error)
  • func (s *Server) RedeployProject(ctx context.Context, r *connect.Request[localv1.RedeployProjectRequest]) (*connect.Response[localv1.RedeployProjectResponse], error)
  • func (s *Server) RegisterHandlers(mux *http.ServeMux, httpPort int, secure, enableUI bool)

Constants

const (
	LogFormatConsole = "console"
	LogFormatJSON    = "json"
)

Default log formats for logger

const (
	DefaultInstanceID   = "default"
	DefaultOLAPDriver   = "duckdb"
	DefaultOLAPDSN      = "main.db"
	DefaultCatalogStore = "meta.db"
	DefaultDBDir        = "tmp"
)

Default instance config on local.

Functions

func IsProjectInit

func IsProjectInit(projectPath string) bool

IsProjectInit checks if the project is initialized by checking if rill.yaml exists in the project directory. It doesn't use any runtime functions since we need the ability to check this before creating the instance.

Types

type App

type App struct {
	Context     context.Context
	Runtime     *runtime.Runtime
	Instance    *drivers.Instance
	Logger      *zap.SugaredLogger
	BaseLogger  *zap.Logger
	Version     cmdutil.Version
	Verbose     bool
	Debug       bool
	ProjectPath string
	// contains filtered or unexported fields
}

App encapsulates the logic associated with configuring and running the UI and the runtime in a local environment. Here, a local environment means a non-authenticated, single-instance and single-project setup on localhost. App encapsulates logic shared between different CLI commands, like start, init, build and source.

func NewApp

func NewApp(ctx context.Context, opts *AppOptions) (*App, error)

func (*App) Close

func (a *App) Close() error

func (*App) Serve

func (a *App) Serve(httpPort, grpcPort int, enableUI, openBrowser, readonly bool, userID, tlsCertPath, tlsKeyPath string) error

type AppOptions

type AppOptions struct {
	Version     cmdutil.Version
	Verbose     bool
	Debug       bool
	Reset       bool
	Environment string
	OlapDriver  string
	OlapDSN     string
	ProjectPath string
	LogFormat   LogFormat
	Variables   map[string]string
	Activity    *activity.Client
	AdminURL    string
	AdminToken  string
	CMDHelper   *cmdutil.Helper
	LocalURL    string
}

type LogFormat

type LogFormat string

func ParseLogFormat

func ParseLogFormat(format string) (LogFormat, bool)

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server implements endpoints for the local Rill app (usually served on localhost).

func (*Server) DeployProject

func (s *Server) DeployProject(ctx context.Context, r *connect.Request[localv1.DeployProjectRequest]) (*connect.Response[localv1.DeployProjectResponse], error)

func (*Server) DeployValidation

func (s *Server) DeployValidation(ctx context.Context, r *connect.Request[localv1.DeployValidationRequest]) (*connect.Response[localv1.DeployValidationResponse], error)

func (*Server) GetCurrentUser

func (s *Server) GetCurrentUser(ctx context.Context, r *connect.Request[localv1.GetCurrentUserRequest]) (*connect.Response[localv1.GetCurrentUserResponse], error)

func (*Server) GetMetadata

func (s *Server) GetMetadata(ctx context.Context, r *connect.Request[localv1.GetMetadataRequest]) (*connect.Response[localv1.GetMetadataResponse], error)

GetMetadata implements localv1connect.LocalServiceHandler.

func (*Server) GetVersion

func (s *Server) GetVersion(ctx context.Context, r *connect.Request[localv1.GetVersionRequest]) (*connect.Response[localv1.GetVersionResponse], error)

GetVersion implements localv1connect.LocalServiceHandler.

func (*Server) Ping

func (s *Server) Ping(ctx context.Context, r *connect.Request[localv1.PingRequest]) (*connect.Response[localv1.PingResponse], error)

Ping implements localv1connect.LocalServiceHandler.

func (*Server) PushToGithub

func (s *Server) PushToGithub(ctx context.Context, r *connect.Request[localv1.PushToGithubRequest]) (*connect.Response[localv1.PushToGithubResponse], error)

PushToGithub assumes that the current project is not a git repo, it should generally be called after DeployValidation.

func (*Server) RedeployProject

func (s *Server) RedeployProject(ctx context.Context, r *connect.Request[localv1.RedeployProjectRequest]) (*connect.Response[localv1.RedeployProjectResponse], error)

func (*Server) RegisterHandlers

func (s *Server) RegisterHandlers(mux *http.ServeMux, httpPort int, secure, enableUI bool)

RegisterHandlers registers the server's handlers on the provided ServeMux.