Documentation
¶
Index ¶
- Constants
- func IsProjectInit(projectPath string) bool
- type App
- type AppOptions
- type LogFormat
- type Server
- 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) 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.
Variables ¶
This section is empty.
Functions ¶
func IsProjectInit ¶ added in v0.36.0
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.
type AppOptions ¶ added in v0.41.0
type Server ¶ added in v0.45.0
type Server struct {
// contains filtered or unexported fields
}
Server implements endpoints for the local Rill app (usually served on localhost).
func (*Server) GetMetadata ¶ added in v0.45.0
func (s *Server) GetMetadata(ctx context.Context, r *connect.Request[localv1.GetMetadataRequest]) (*connect.Response[localv1.GetMetadataResponse], error)
GetMetadata implements localv1connect.LocalServiceHandler.
func (*Server) GetVersion ¶ added in v0.45.0
func (s *Server) GetVersion(ctx context.Context, r *connect.Request[localv1.GetVersionRequest]) (*connect.Response[localv1.GetVersionResponse], error)
GetVersion implements localv1connect.LocalServiceHandler.