server

package
v0.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 6, 2023 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrForbidden = status.Error(codes.Unauthenticated, "action not allowed")

Functions

func HTTPErrorHandler added in v0.17.0 

func HTTPErrorHandler(ctx context.Context, mux *gateway.ServeMux, marshaler gateway.Marshaler, w http.ResponseWriter, r *http.Request, err error)

HTTPErrorHandler wraps gateway.DefaultHTTPErrorHandler to map gRPC unknown errors (i.e. errors without an explicit code) to HTTP status code 400 instead of 500.

Types

type ColumnInfo added in v0.15.0 

type ColumnInfo struct {
	Name    string
	Type    string
	Unknown int
}

type Options added in v0.16.0 

type Options struct {
	HTTPPort        int
	GRPCPort        int
	AllowedOrigins  []string
	ServePrometheus bool
	AuthEnable      bool
	AuthIssuerURL   string
	AuthAudienceURL string
}

type Server 

type Server struct {
	runtimev1.UnsafeRuntimeServiceServer
	runtimev1.UnsafeQueryServiceServer
	runtimev1.UnsafeConnectorServiceServer
	// contains filtered or unexported fields
}

func NewServer 

func NewServer(ctx context.Context, opts *Options, rt *runtime.Runtime, logger *zap.Logger, limiter ratelimit.Limiter) (*Server, error)

NewServer creates a new runtime server. The provided ctx is used for the lifetime of the server for background refresh of the JWKS that is used to validate auth tokens.

func (*Server) Close added in v0.22.0 

func (s *Server) Close() error

Close should be called when the server is done

func (*Server) ColumnCardinality added in v0.22.0 

func (s *Server) ColumnCardinality(ctx context.Context, req *runtimev1.ColumnCardinalityRequest) (*runtimev1.ColumnCardinalityResponse, error)

func (*Server) ColumnDescriptiveStatistics added in v0.22.0 

func (s *Server) ColumnDescriptiveStatistics(ctx context.Context, req *runtimev1.ColumnDescriptiveStatisticsRequest) (*runtimev1.ColumnDescriptiveStatisticsResponse, error)

func (*Server) ColumnNullCount added in v0.22.0 

func (s *Server) ColumnNullCount(ctx context.Context, req *runtimev1.ColumnNullCountRequest) (*runtimev1.ColumnNullCountResponse, error)

func (*Server) ColumnNumericHistogram added in v0.22.0 

func (s *Server) ColumnNumericHistogram(ctx context.Context, req *runtimev1.ColumnNumericHistogramRequest) (*runtimev1.ColumnNumericHistogramResponse, error)

func (*Server) ColumnRollupInterval added in v0.22.0 

func (s *Server) ColumnRollupInterval(ctx context.Context, req *runtimev1.ColumnRollupIntervalRequest) (*runtimev1.ColumnRollupIntervalResponse, error)

Metrics/Timeseries APIs

func (*Server) ColumnRugHistogram added in v0.22.0 

func (s *Server) ColumnRugHistogram(ctx context.Context, req *runtimev1.ColumnRugHistogramRequest) (*runtimev1.ColumnRugHistogramResponse, error)

func (*Server) ColumnTimeGrain added in v0.22.0 

func (s *Server) ColumnTimeGrain(ctx context.Context, req *runtimev1.ColumnTimeGrainRequest) (*runtimev1.ColumnTimeGrainResponse, error)

func (*Server) ColumnTimeRange added in v0.22.0 

func (s *Server) ColumnTimeRange(ctx context.Context, req *runtimev1.ColumnTimeRangeRequest) (*runtimev1.ColumnTimeRangeResponse, error)

func (*Server) ColumnTimeSeries added in v0.22.0 

func (s *Server) ColumnTimeSeries(ctx context.Context, req *runtimev1.ColumnTimeSeriesRequest) (*runtimev1.ColumnTimeSeriesResponse, error)

func (*Server) ColumnTopK added in v0.22.0 

func (s *Server) ColumnTopK(ctx context.Context, req *runtimev1.ColumnTopKRequest) (*runtimev1.ColumnTopKResponse, error)

func (*Server) CreateInstance 

func (s *Server) CreateInstance(ctx context.Context, req *runtimev1.CreateInstanceRequest) (*runtimev1.CreateInstanceResponse, error)

CreateInstance implements RuntimeService.

func (*Server) DeleteFile added in v0.15.0 

func (s *Server) DeleteFile(ctx context.Context, req *runtimev1.DeleteFileRequest) (*runtimev1.DeleteFileResponse, error)

DeleteFile implements RuntimeService.

func (*Server) DeleteFileAndReconcile added in v0.16.0 

func (s *Server) DeleteFileAndReconcile(ctx context.Context, req *runtimev1.DeleteFileAndReconcileRequest) (*runtimev1.DeleteFileAndReconcileResponse, error)

DeleteFileAndReconcile implements RuntimeService.

func (*Server) DeleteInstance 

func (s *Server) DeleteInstance(ctx context.Context, req *runtimev1.DeleteInstanceRequest) (*runtimev1.DeleteInstanceResponse, error)

DeleteInstance implements RuntimeService.

func (*Server) EditInstance added in v0.23.0 

func (s *Server) EditInstance(ctx context.Context, req *runtimev1.EditInstanceRequest) (*runtimev1.EditInstanceResponse, error)

EditInstance implements RuntimeService.

func (*Server) EditInstanceVariables added in v0.28.0 

func (s *Server) EditInstanceVariables(ctx context.Context, req *runtimev1.EditInstanceVariablesRequest) (*runtimev1.EditInstanceVariablesResponse, error)

EditInstanceVariables implements RuntimeService.

func (*Server) Export added in v0.27.3 

func (s *Server) Export(ctx context.Context, req *runtimev1.ExportRequest) (*runtimev1.ExportResponse, error)

func (*Server) ExportTable added in v0.16.0 

func (s *Server) ExportTable(w http.ResponseWriter, req *http.Request, pathParams map[string]string)

ExportTable exports a table or view as a flat file and triggers a HTTP download of it. It's mounted as a REST API only, and is not available over gRPC.

TODO: This is a temporary hack that only supports DuckDB. We should add a generic workflow for data export that also supports possibly very large tables.

func (*Server) GCSGetCredentialsInfo added in v0.27.0 

func (s *Server) GCSGetCredentialsInfo(ctx context.Context, req *runtimev1.GCSGetCredentialsInfoRequest) (*runtimev1.GCSGetCredentialsInfoResponse, error)

func (*Server) GCSListBuckets added in v0.27.0 

func (s *Server) GCSListBuckets(ctx context.Context, req *runtimev1.GCSListBucketsRequest) (*runtimev1.GCSListBucketsResponse, error)

func (*Server) GCSListObjects added in v0.27.0 

func (s *Server) GCSListObjects(ctx context.Context, req *runtimev1.GCSListObjectsRequest) (*runtimev1.GCSListObjectsResponse, error)

func (*Server) GetCatalogEntry added in v0.16.0 

func (s *Server) GetCatalogEntry(ctx context.Context, req *runtimev1.GetCatalogEntryRequest) (*runtimev1.GetCatalogEntryResponse, error)

GetCatalogEntry implements RuntimeService.

func (*Server) GetFile added in v0.15.0 

func (s *Server) GetFile(ctx context.Context, req *runtimev1.GetFileRequest) (*runtimev1.GetFileResponse, error)

GetFile implements RuntimeService.

func (*Server) GetInstance 

func (s *Server) GetInstance(ctx context.Context, req *runtimev1.GetInstanceRequest) (*runtimev1.GetInstanceResponse, error)

GetInstance implements RuntimeService.

func (*Server) HTTPHandler added in v0.15.0 

func (s *Server) HTTPHandler(ctx context.Context, registerAdditionalHandlers func(mux *http.ServeMux)) (http.Handler, error)

HTTPHandler HTTP handler serving REST gateway.

func (*Server) ListCatalogEntries added in v0.16.0 

func (s *Server) ListCatalogEntries(ctx context.Context, req *runtimev1.ListCatalogEntriesRequest) (*runtimev1.ListCatalogEntriesResponse, error)

ListCatalogEntries implements RuntimeService.

func (*Server) ListConnectors 

func (s *Server) ListConnectors(ctx context.Context, req *runtimev1.ListConnectorsRequest) (*runtimev1.ListConnectorsResponse, error)

ListConnectors implements RuntimeService.

func (*Server) ListExamples added in v0.26.0 

func (s *Server) ListExamples(ctx context.Context, req *runtimev1.ListExamplesRequest) (*runtimev1.ListExamplesResponse, error)

ListExamples returns a list of embedded examples

func (*Server) ListFiles added in v0.15.0 

func (s *Server) ListFiles(ctx context.Context, req *runtimev1.ListFilesRequest) (*runtimev1.ListFilesResponse, error)

ListFiles implements RuntimeService.

func (*Server) ListInstances 

func (s *Server) ListInstances(ctx context.Context, req *runtimev1.ListInstancesRequest) (*runtimev1.ListInstancesResponse, error)

ListInstances implements RuntimeService.

func (*Server) MetricsViewComparisonToplist added in v0.25.2 

func (s *Server) MetricsViewComparisonToplist(ctx context.Context, req *runtimev1.MetricsViewComparisonToplistRequest) (*runtimev1.MetricsViewComparisonToplistResponse, error)

MetricsViewComparisonToplist implements QueryService.

func (*Server) MetricsViewRows added in v0.24.4 

func (s *Server) MetricsViewRows(ctx context.Context, req *runtimev1.MetricsViewRowsRequest) (*runtimev1.MetricsViewRowsResponse, error)

MetricsViewRows implements QueryService.

func (*Server) MetricsViewTimeSeries 

func (s *Server) MetricsViewTimeSeries(ctx context.Context, req *runtimev1.MetricsViewTimeSeriesRequest) (*runtimev1.MetricsViewTimeSeriesResponse, error)

MetricsViewTimeSeries implements QueryService.

func (*Server) MetricsViewToplist 

func (s *Server) MetricsViewToplist(ctx context.Context, req *runtimev1.MetricsViewToplistRequest) (*runtimev1.MetricsViewToplistResponse, error)

MetricsViewToplist implements QueryService.

func (*Server) MetricsViewTotals 

func (s *Server) MetricsViewTotals(ctx context.Context, req *runtimev1.MetricsViewTotalsRequest) (*runtimev1.MetricsViewTotalsResponse, error)

MetricsViewTotals implements QueryService.

func (*Server) Ping 

func (s *Server) Ping(ctx context.Context, req *runtimev1.PingRequest) (*runtimev1.PingResponse, error)

Ping implements RuntimeService

func (*Server) PutFile added in v0.15.0 

func (s *Server) PutFile(ctx context.Context, req *runtimev1.PutFileRequest) (*runtimev1.PutFileResponse, error)

PutFile implements RuntimeService.

func (*Server) PutFileAndReconcile added in v0.16.0 

func (s *Server) PutFileAndReconcile(ctx context.Context, req *runtimev1.PutFileAndReconcileRequest) (*runtimev1.PutFileAndReconcileResponse, error)

PutFileAndReconcile implements RuntimeService.

func (*Server) Query 

func (s *Server) Query(ctx context.Context, req *runtimev1.QueryRequest) (*runtimev1.QueryResponse, error)

Query implements QueryService.

func (*Server) Reconcile added in v0.16.0 

func (s *Server) Reconcile(ctx context.Context, req *runtimev1.ReconcileRequest) (*runtimev1.ReconcileResponse, error)

Reconcile implements RuntimeService.

func (*Server) RefreshAndReconcile added in v0.16.0 

func (s *Server) RefreshAndReconcile(ctx context.Context, req *runtimev1.RefreshAndReconcileRequest) (*runtimev1.RefreshAndReconcileResponse, error)

RefreshAndReconcile implements RuntimeService.

func (*Server) RenameFile added in v0.15.0 

func (s *Server) RenameFile(ctx context.Context, req *runtimev1.RenameFileRequest) (*runtimev1.RenameFileResponse, error)

RenameFile implements RuntimeService.

func (*Server) RenameFileAndReconcile added in v0.16.0 

func (s *Server) RenameFileAndReconcile(ctx context.Context, req *runtimev1.RenameFileAndReconcileRequest) (*runtimev1.RenameFileAndReconcileResponse, error)

RenameFileAndReconcile implements RuntimeService.

func (*Server) S3GetBucketMetadata added in v0.27.0 

func (s *Server) S3GetBucketMetadata(ctx context.Context, req *runtimev1.S3GetBucketMetadataRequest) (*runtimev1.S3GetBucketMetadataResponse, error)

func (*Server) S3GetCredentialsInfo added in v0.27.0 

func (s *Server) S3GetCredentialsInfo(ctx context.Context, req *runtimev1.S3GetCredentialsInfoRequest) (*runtimev1.S3GetCredentialsInfoResponse, error)

func (*Server) S3ListBuckets added in v0.27.0 

func (s *Server) S3ListBuckets(ctx context.Context, req *runtimev1.S3ListBucketsRequest) (*runtimev1.S3ListBucketsResponse, error)

func (*Server) S3ListObjects added in v0.27.0 

func (s *Server) S3ListObjects(ctx context.Context, req *runtimev1.S3ListObjectsRequest) (*runtimev1.S3ListObjectsResponse, error)

func (*Server) ServeGRPC added in v0.15.0 

func (s *Server) ServeGRPC(ctx context.Context) error

ServeGRPC Starts the gRPC server.

func (*Server) ServeHTTP added in v0.15.0 

func (s *Server) ServeHTTP(ctx context.Context, registerAdditionalHandlers func(mux *http.ServeMux)) error

Starts the HTTP server.

func (*Server) TableCardinality added in v0.15.0 

func (s *Server) TableCardinality(ctx context.Context, req *runtimev1.TableCardinalityRequest) (*runtimev1.TableCardinalityResponse, error)

Table level profiling APIs.

func (*Server) TableColumns added in v0.22.0 

func (s *Server) TableColumns(ctx context.Context, req *runtimev1.TableColumnsRequest) (*runtimev1.TableColumnsResponse, error)

func (*Server) TableRows added in v0.15.0 

func (s *Server) TableRows(ctx context.Context, req *runtimev1.TableRowsRequest) (*runtimev1.TableRowsResponse, error)

func (*Server) TriggerRefresh 

func (s *Server) TriggerRefresh(ctx context.Context, req *runtimev1.TriggerRefreshRequest) (*runtimev1.TriggerRefreshResponse, error)

TriggerRefresh implements RuntimeService.

func (*Server) TriggerSync added in v0.15.0 

func (s *Server) TriggerSync(ctx context.Context, req *runtimev1.TriggerSyncRequest) (*runtimev1.TriggerSyncResponse, error)

TriggerSync implements RuntimeService.

func (*Server) UnpackEmpty added in v0.26.0 

func (s *Server) UnpackEmpty(ctx context.Context, req *runtimev1.UnpackEmptyRequest) (*runtimev1.UnpackEmptyResponse, error)

func (*Server) UnpackExample added in v0.26.0 

func (s *Server) UnpackExample(ctx context.Context, req *runtimev1.UnpackExampleRequest) (*runtimev1.UnpackExampleResponse, error)

func (*Server) UploadMultipartFile added in v0.15.0 

func (s *Server) UploadMultipartFile(w http.ResponseWriter, req *http.Request, pathParams map[string]string)

UploadMultipartFile implements the same functionality as PutFile, but for multipart HTTP upload. It's mounted only on as a REST API and enables upload of large files (such as data files).

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.