explorerconnect

Documentation

Index

• Constants
• func NewExplorerServiceHandler(svc ExplorerServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type ExplorerServiceClient
  • func NewExplorerServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) ExplorerServiceClient
• type ExplorerServiceHandler
• type UnimplementedExplorerServiceHandler
  • func (UnimplementedExplorerServiceHandler) GetQueryExplain(context.Context, *connect_go.Request[explorer.QueryExplainRequest]) (*connect_go.Response[explorer.QueryExplainResponse], error)
  • func (UnimplementedExplorerServiceHandler) GetSupportQuery(context.Context, *connect_go.Request[explorer.SupportQueryRequest]) (*connect_go.Response[explorer.SupportQueryResponse], error)
  • func (UnimplementedExplorerServiceHandler) GetWeeksOfData(context.Context, *connect_go.Request[explorer.GetWeeksOfDataRequest]) (*connect_go.Response[explorer.GetWeeksOfDataResponse], error)
  • func (UnimplementedExplorerServiceHandler) ListDatasourceSchemas(context.Context, *connect_go.Request[explorer.ListDatasourceSchemasRequest]) (*connect_go.Response[explorer.ListDatasourceSchemasResponse], error)
  • func (UnimplementedExplorerServiceHandler) Query(context.Context, *connect_go.Request[explorer.QueryRequest]) (*connect_go.Response[explorer.QueryResponse], error)

Constants

const (
	// ExplorerServiceListDatasourceSchemasProcedure is the fully-qualified name of the
	// ExplorerService's ListDatasourceSchemas RPC.
	ExplorerServiceListDatasourceSchemasProcedure = "/api.v1alpha1.explorer.ExplorerService/ListDatasourceSchemas"
	// ExplorerServiceQueryProcedure is the fully-qualified name of the ExplorerService's Query RPC.
	ExplorerServiceQueryProcedure = "/api.v1alpha1.explorer.ExplorerService/Query"
	// ExplorerServiceGetSupportQueryProcedure is the fully-qualified name of the ExplorerService's
	// GetSupportQuery RPC.
	ExplorerServiceGetSupportQueryProcedure = "/api.v1alpha1.explorer.ExplorerService/GetSupportQuery"
	// ExplorerServiceGetQueryExplainProcedure is the fully-qualified name of the ExplorerService's
	// GetQueryExplain RPC.
	ExplorerServiceGetQueryExplainProcedure = "/api.v1alpha1.explorer.ExplorerService/GetQueryExplain"
	// ExplorerServiceGetWeeksOfDataProcedure is the fully-qualified name of the ExplorerService's
	// GetWeeksOfData RPC.
	ExplorerServiceGetWeeksOfDataProcedure = "/api.v1alpha1.explorer.ExplorerService/GetWeeksOfData"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

const (
	// ExplorerServiceName is the fully-qualified name of the ExplorerService service.
	ExplorerServiceName = "api.v1alpha1.explorer.ExplorerService"
)

Functions

func NewExplorerServiceHandler

func NewExplorerServiceHandler(svc ExplorerServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewExplorerServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type ExplorerServiceClient

type ExplorerServiceClient interface {
	// ListDatasourceSchemas lists all accessible datasources and their schemas.
	ListDatasourceSchemas(context.Context, *connect_go.Request[explorer.ListDatasourceSchemasRequest]) (*connect_go.Response[explorer.ListDatasourceSchemasResponse], error)
	// Query queries a datasource.
	Query(context.Context, *connect_go.Request[explorer.QueryRequest]) (*connect_go.Response[explorer.QueryResponse], error)
	GetSupportQuery(context.Context, *connect_go.Request[explorer.SupportQueryRequest]) (*connect_go.Response[explorer.SupportQueryResponse], error)
	GetQueryExplain(context.Context, *connect_go.Request[explorer.QueryExplainRequest]) (*connect_go.Response[explorer.QueryExplainResponse], error)
	// GetWeeksOfData returns the number of weeks of data an org is limited to and the cutoff date.
	GetWeeksOfData(context.Context, *connect_go.Request[explorer.GetWeeksOfDataRequest]) (*connect_go.Response[explorer.GetWeeksOfDataResponse], error)
}

ExplorerServiceClient is a client for the api.v1alpha1.explorer.ExplorerService service.

func NewExplorerServiceClient

func NewExplorerServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) ExplorerServiceClient

NewExplorerServiceClient constructs a client for the api.v1alpha1.explorer.ExplorerService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type ExplorerServiceHandler

type ExplorerServiceHandler interface {
	// ListDatasourceSchemas lists all accessible datasources and their schemas.
	ListDatasourceSchemas(context.Context, *connect_go.Request[explorer.ListDatasourceSchemasRequest]) (*connect_go.Response[explorer.ListDatasourceSchemasResponse], error)
	// Query queries a datasource.
	Query(context.Context, *connect_go.Request[explorer.QueryRequest]) (*connect_go.Response[explorer.QueryResponse], error)
	GetSupportQuery(context.Context, *connect_go.Request[explorer.SupportQueryRequest]) (*connect_go.Response[explorer.SupportQueryResponse], error)
	GetQueryExplain(context.Context, *connect_go.Request[explorer.QueryExplainRequest]) (*connect_go.Response[explorer.QueryExplainResponse], error)
	// GetWeeksOfData returns the number of weeks of data an org is limited to and the cutoff date.
	GetWeeksOfData(context.Context, *connect_go.Request[explorer.GetWeeksOfDataRequest]) (*connect_go.Response[explorer.GetWeeksOfDataResponse], error)
}

ExplorerServiceHandler is an implementation of the api.v1alpha1.explorer.ExplorerService service.

type UnimplementedExplorerServiceHandler

type UnimplementedExplorerServiceHandler struct{}

UnimplementedExplorerServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedExplorerServiceHandler) GetQueryExplain

func (UnimplementedExplorerServiceHandler) GetQueryExplain(context.Context, *connect_go.Request[explorer.QueryExplainRequest]) (*connect_go.Response[explorer.QueryExplainResponse], error)

func (UnimplementedExplorerServiceHandler) GetSupportQuery

func (UnimplementedExplorerServiceHandler) GetSupportQuery(context.Context, *connect_go.Request[explorer.SupportQueryRequest]) (*connect_go.Response[explorer.SupportQueryResponse], error)

func (UnimplementedExplorerServiceHandler) GetWeeksOfData

func (UnimplementedExplorerServiceHandler) GetWeeksOfData(context.Context, *connect_go.Request[explorer.GetWeeksOfDataRequest]) (*connect_go.Response[explorer.GetWeeksOfDataResponse], error)

func (UnimplementedExplorerServiceHandler) ListDatasourceSchemas

func (UnimplementedExplorerServiceHandler) ListDatasourceSchemas(context.Context, *connect_go.Request[explorer.ListDatasourceSchemasRequest]) (*connect_go.Response[explorer.ListDatasourceSchemasResponse], error)

func (UnimplementedExplorerServiceHandler) Query

func (UnimplementedExplorerServiceHandler) Query(context.Context, *connect_go.Request[explorer.QueryRequest]) (*connect_go.Response[explorer.QueryResponse], error)