explorer

package
v1.8.29 Latest Latest
Warning

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

 Go to latest Published: Nov 12, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ExplorerService_ListDatasourceSchemas_FullMethodName = "/api.v1alpha1.explorer.ExplorerService/ListDatasourceSchemas"
	ExplorerService_Query_FullMethodName                 = "/api.v1alpha1.explorer.ExplorerService/Query"
)

Variables

View Source 
var (
	ExportFormat_name = map[int32]string{
		0: "REPORT_FORMAT_UNSPECIFIED",
		1: "REPORT_FORMAT_CSV",
		2: "REPORT_FORMAT_PARQUET",
	}
	ExportFormat_value = map[string]int32{
		"REPORT_FORMAT_UNSPECIFIED": 0,
		"REPORT_FORMAT_CSV":         1,
		"REPORT_FORMAT_PARQUET":     2,
	}
)

Enum value maps for ExportFormat.

View Source 
var (
	SchemaType_name = map[int32]string{
		0:  "SCHEMA_TYPE_UNSPECIFIED",
		2:  "SCHEMA_TYPE_INT",
		3:  "SCHEMA_TYPE_FLOAT",
		5:  "SCHEMA_TYPE_STRING",
		6:  "SCHEMA_TYPE_BOOL",
		7:  "SCHEMA_TYPE_TIMESTAMP",
		8:  "SCHEMA_TYPE_INT_ARRAY",
		9:  "SCHEMA_TYPE_FLOAT_ARRAY",
		10: "SCHEMA_TYPE_STRING_ARRAY",
		11: "SCHEMA_TYPE_BOOL_ARRAY",
		12: "SCHEMA_TYPE_MAP",
	}
	SchemaType_value = map[string]int32{
		"SCHEMA_TYPE_UNSPECIFIED":  0,
		"SCHEMA_TYPE_INT":          2,
		"SCHEMA_TYPE_FLOAT":        3,
		"SCHEMA_TYPE_STRING":       5,
		"SCHEMA_TYPE_BOOL":         6,
		"SCHEMA_TYPE_TIMESTAMP":    7,
		"SCHEMA_TYPE_INT_ARRAY":    8,
		"SCHEMA_TYPE_FLOAT_ARRAY":  9,
		"SCHEMA_TYPE_STRING_ARRAY": 10,
		"SCHEMA_TYPE_BOOL_ARRAY":   11,
		"SCHEMA_TYPE_MAP":          12,
	}
)

Enum value maps for SchemaType.

View Source 
var (
	DatasourceType_name = map[int32]string{
		0: "DATASOURCE_TYPE_UNSPECIFIED",
		1: "DATASOURCE_TYPE_VFS",
		2: "DATASOURCE_TYPE_CLICKHOUSE",
	}
	DatasourceType_value = map[string]int32{
		"DATASOURCE_TYPE_UNSPECIFIED": 0,
		"DATASOURCE_TYPE_VFS":         1,
		"DATASOURCE_TYPE_CLICKHOUSE":  2,
	}
)

Enum value maps for DatasourceType.

View Source 
var ExplorerService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1alpha1.explorer.ExplorerService",
	HandlerType: (*ExplorerServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListDatasourceSchemas",
			Handler:    _ExplorerService_ListDatasourceSchemas_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _ExplorerService_Query_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/v1alpha1/explorer/service.proto",
}

ExplorerService_ServiceDesc is the grpc.ServiceDesc for ExplorerService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_api_v1alpha1_explorer_entities_proto protoreflect.FileDescriptor
View Source 
var File_api_v1alpha1_explorer_service_proto protoreflect.FileDescriptor

Functions

func RegisterExplorerServiceServer 

func RegisterExplorerServiceServer(s grpc.ServiceRegistrar, srv ExplorerServiceServer)

Types

type DatasourceType 

type DatasourceType int32

DatasourceType is an enum for the type of a datasource. 

const (
	DatasourceType_DATASOURCE_TYPE_UNSPECIFIED DatasourceType = 0
	DatasourceType_DATASOURCE_TYPE_VFS         DatasourceType = 1
	DatasourceType_DATASOURCE_TYPE_CLICKHOUSE  DatasourceType = 2
)

func (DatasourceType) Descriptor 

func (DatasourceType) Descriptor() protoreflect.EnumDescriptor

func (DatasourceType) Enum 

func (x DatasourceType) Enum() *DatasourceType

func (DatasourceType) EnumDescriptor deprecated 

func (DatasourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DatasourceType.Descriptor instead.

func (DatasourceType) Number 

func (x DatasourceType) Number() protoreflect.EnumNumber

func (DatasourceType) String 

func (x DatasourceType) String() string

func (DatasourceType) Type 

func (DatasourceType) Type() protoreflect.EnumType

type ExplorerServiceClient 

type ExplorerServiceClient interface {
	// ListDatasourceSchemas lists all accessible datasources and their schemas.
	ListDatasourceSchemas(ctx context.Context, in *ListDatasourceSchemasRequest, opts ...grpc.CallOption) (*ListDatasourceSchemasResponse, error)
	// Query queries a datasource.
	Query(ctx context.Context, in *QueryRequest, opts ...grpc.CallOption) (*QueryResponse, error)
}

ExplorerServiceClient is the client API for ExplorerService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

ExplorerService is the service for the explorer API.

func NewExplorerServiceClient 

func NewExplorerServiceClient(cc grpc.ClientConnInterface) ExplorerServiceClient

type ExplorerServiceServer 

type ExplorerServiceServer interface {
	// ListDatasourceSchemas lists all accessible datasources and their schemas.
	ListDatasourceSchemas(context.Context, *ListDatasourceSchemasRequest) (*ListDatasourceSchemasResponse, error)
	// Query queries a datasource.
	Query(context.Context, *QueryRequest) (*QueryResponse, error)
	// contains filtered or unexported methods
}

ExplorerServiceServer is the server API for ExplorerService service. All implementations must embed UnimplementedExplorerServiceServer for forward compatibility.

ExplorerService is the service for the explorer API.

type ExportFormat added in v1.8.13 

type ExportFormat int32

ExportFormat is an enum for the format of a report. 

const (
	ExportFormat_REPORT_FORMAT_UNSPECIFIED ExportFormat = 0
	ExportFormat_REPORT_FORMAT_CSV         ExportFormat = 1
	ExportFormat_REPORT_FORMAT_PARQUET     ExportFormat = 2
)

func (ExportFormat) Descriptor added in v1.8.13 

func (ExportFormat) Descriptor() protoreflect.EnumDescriptor

func (ExportFormat) Enum added in v1.8.13 

func (x ExportFormat) Enum() *ExportFormat

func (ExportFormat) EnumDescriptor deprecated added in v1.8.13 

func (ExportFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use ExportFormat.Descriptor instead.

func (ExportFormat) Number added in v1.8.13 

func (x ExportFormat) Number() protoreflect.EnumNumber

func (ExportFormat) String added in v1.8.13 

func (x ExportFormat) String() string

func (ExportFormat) Type added in v1.8.13 

func (ExportFormat) Type() protoreflect.EnumType

type ListDatasourceSchemasRequest 

type ListDatasourceSchemasRequest struct {

	// datasource_names is a table name filter for the datasources to list.
	DatasourceNames []string `protobuf:"bytes,1,rep,name=datasource_names,json=datasourceNames,proto3" json:"datasource_names,omitempty"`
	// datasource_type is the type of the datasource to list.
	// If not specified, all datasources will be listed.
	DatasourceType DatasourceType `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

ListDatasourceSchemasRequest is the request to list datasource schemas.

func (*ListDatasourceSchemasRequest) Descriptor deprecated 

func (*ListDatasourceSchemasRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasourceSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListDatasourceSchemasRequest) GetDatasourceNames added in v1.8.13 

func (x *ListDatasourceSchemasRequest) GetDatasourceNames() []string

func (*ListDatasourceSchemasRequest) GetDatasourceType added in v1.8.13 

func (x *ListDatasourceSchemasRequest) GetDatasourceType() DatasourceType

func (*ListDatasourceSchemasRequest) ProtoMessage 

func (*ListDatasourceSchemasRequest) ProtoMessage()

func (*ListDatasourceSchemasRequest) ProtoReflect 

func (x *ListDatasourceSchemasRequest) ProtoReflect() protoreflect.Message

func (*ListDatasourceSchemasRequest) Reset 

func (x *ListDatasourceSchemasRequest) Reset()

func (*ListDatasourceSchemasRequest) String 

func (x *ListDatasourceSchemasRequest) String() string

type ListDatasourceSchemasResponse 

type ListDatasourceSchemasResponse struct {

	// list of schemas
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// contains filtered or unexported fields
}

ListDatasourceSchemasResponse contains datasources and their schemas.

func (*ListDatasourceSchemasResponse) Descriptor deprecated 

func (*ListDatasourceSchemasResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDatasourceSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListDatasourceSchemasResponse) GetSchemas 

func (x *ListDatasourceSchemasResponse) GetSchemas() []*Schema

func (*ListDatasourceSchemasResponse) ProtoMessage 

func (*ListDatasourceSchemasResponse) ProtoMessage()

func (*ListDatasourceSchemasResponse) ProtoReflect 

func (x *ListDatasourceSchemasResponse) ProtoReflect() protoreflect.Message

func (*ListDatasourceSchemasResponse) Reset 

func (x *ListDatasourceSchemasResponse) Reset()

func (*ListDatasourceSchemasResponse) String 

func (x *ListDatasourceSchemasResponse) String() string

type Parameters 

type Parameters struct {
	Parameters map[string]*Parameters_Parameter `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Parameter is a parameter for a query.

func (*Parameters) Descriptor deprecated 

func (*Parameters) Descriptor() ([]byte, []int)

Deprecated: Use Parameters.ProtoReflect.Descriptor instead.

func (*Parameters) GetParameters 

func (x *Parameters) GetParameters() map[string]*Parameters_Parameter

func (*Parameters) ProtoMessage 

func (*Parameters) ProtoMessage()

func (*Parameters) ProtoReflect 

func (x *Parameters) ProtoReflect() protoreflect.Message

func (*Parameters) Reset 

func (x *Parameters) Reset()

func (*Parameters) String 

func (x *Parameters) String() string

type Parameters_Parameter 

type Parameters_Parameter struct {
	Value    string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	DataType string `protobuf:"bytes,3,opt,name=data_type,json=dataType,proto3" json:"data_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Parameters_Parameter) Descriptor deprecated 

func (*Parameters_Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Parameters_Parameter.ProtoReflect.Descriptor instead.

func (*Parameters_Parameter) GetDataType 

func (x *Parameters_Parameter) GetDataType() string

func (*Parameters_Parameter) GetValue 

func (x *Parameters_Parameter) GetValue() string

func (*Parameters_Parameter) ProtoMessage 

func (*Parameters_Parameter) ProtoMessage()

func (*Parameters_Parameter) ProtoReflect 

func (x *Parameters_Parameter) ProtoReflect() protoreflect.Message

func (*Parameters_Parameter) Reset 

func (x *Parameters_Parameter) Reset()

func (*Parameters_Parameter) String 

func (x *Parameters_Parameter) String() string

type QueryRequest 

type QueryRequest struct {

	// datasource_name is the name of the datasource to query.
	DatasourceName string `protobuf:"bytes,1,opt,name=datasource_name,json=datasourceName,proto3" json:"datasource_name,omitempty"`
	// datasource_type is the type of the datasource to query.
	DatasourceType DatasourceType `` /* 146-byte string literal not displayed */
	// query is the query to execute.
	//
	// Types that are assignable to Query:
	//
	//	*QueryRequest_Pipeline
	//	*QueryRequest_Prql
	Query isQueryRequest_Query `protobuf_oneof:"query"`
	// org_id for ownership of the data
	OrgIds []string `protobuf:"bytes,5,rep,name=org_ids,json=orgIds,proto3" json:"org_ids,omitempty"`
	// start_time is the start time of the query.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// end_time is the end time of the query.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// timezone is IESG timezone name
	// this is how the timezone is represented in the query
	Timezone string `protobuf:"bytes,8,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// pipeline_parameters is the parameters for the pipeline.
	PipelineParameters *Parameters `protobuf:"bytes,9,opt,name=pipeline_parameters,json=pipelineParameters,proto3" json:"pipeline_parameters,omitempty"`
	// ui_trace_id is the trace id of the query.
	UiTraceId string `protobuf:"bytes,10,opt,name=ui_trace_id,json=uiTraceId,proto3" json:"ui_trace_id,omitempty"`
	// comment is the comment for the query.
	Comment string `protobuf:"bytes,11,opt,name=comment,proto3" json:"comment,omitempty"`
	// format is the format of the result.
	Format ExportFormat `protobuf:"varint,12,opt,name=format,proto3,enum=api.v1alpha1.explorer.ExportFormat" json:"format,omitempty"`
	// contains filtered or unexported fields
}

QueryRequest is the request to query a datasource.

func (*QueryRequest) Descriptor deprecated 

func (*QueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryRequest.ProtoReflect.Descriptor instead.

func (*QueryRequest) GetComment 

func (x *QueryRequest) GetComment() string

func (*QueryRequest) GetDatasourceName 

func (x *QueryRequest) GetDatasourceName() string

func (*QueryRequest) GetDatasourceType 

func (x *QueryRequest) GetDatasourceType() DatasourceType

func (*QueryRequest) GetEndTime 

func (x *QueryRequest) GetEndTime() *timestamppb.Timestamp

func (*QueryRequest) GetFormat added in v1.8.13 

func (x *QueryRequest) GetFormat() ExportFormat

func (*QueryRequest) GetOrgIds 

func (x *QueryRequest) GetOrgIds() []string

func (*QueryRequest) GetPipeline 

func (x *QueryRequest) GetPipeline() string

func (*QueryRequest) GetPipelineParameters 

func (x *QueryRequest) GetPipelineParameters() *Parameters

func (*QueryRequest) GetPrql 

func (x *QueryRequest) GetPrql() string

func (*QueryRequest) GetQuery 

func (m *QueryRequest) GetQuery() isQueryRequest_Query

func (*QueryRequest) GetStartTime 

func (x *QueryRequest) GetStartTime() *timestamppb.Timestamp

func (*QueryRequest) GetTimezone 

func (x *QueryRequest) GetTimezone() string

func (*QueryRequest) GetUiTraceId 

func (x *QueryRequest) GetUiTraceId() string

func (*QueryRequest) ProtoMessage 

func (*QueryRequest) ProtoMessage()

func (*QueryRequest) ProtoReflect 

func (x *QueryRequest) ProtoReflect() protoreflect.Message

func (*QueryRequest) Reset 

func (x *QueryRequest) Reset()

func (*QueryRequest) String 

func (x *QueryRequest) String() string

type QueryRequest_Pipeline 

type QueryRequest_Pipeline struct {
	// pipeline to be compiled to prql
	Pipeline string `protobuf:"bytes,3,opt,name=pipeline,proto3,oneof"`
}

type QueryRequest_Prql 

type QueryRequest_Prql struct {
	// prql query to execute
	Prql string `protobuf:"bytes,4,opt,name=prql,proto3,oneof"`
}

type QueryResponse 

type QueryResponse struct {

	// result_url is the URL to the result of the query.
	ResultUrl string `protobuf:"bytes,1,opt,name=result_url,json=resultUrl,proto3" json:"result_url,omitempty"`
	// result_size_bytes is the size of the result in bytes.
	ResultSizeBytes int64 `protobuf:"varint,2,opt,name=result_size_bytes,json=resultSizeBytes,proto3" json:"result_size_bytes,omitempty"`
	// contains filtered or unexported fields
}

QueryResponse contains the result of a datasource query.

func (*QueryResponse) Descriptor deprecated 

func (*QueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryResponse.ProtoReflect.Descriptor instead.

func (*QueryResponse) GetResultSizeBytes 

func (x *QueryResponse) GetResultSizeBytes() int64

func (*QueryResponse) GetResultUrl 

func (x *QueryResponse) GetResultUrl() string

func (*QueryResponse) ProtoMessage 

func (*QueryResponse) ProtoMessage()

func (*QueryResponse) ProtoReflect 

func (x *QueryResponse) ProtoReflect() protoreflect.Message

func (*QueryResponse) Reset 

func (x *QueryResponse) Reset()

func (*QueryResponse) String 

func (x *QueryResponse) String() string

type Schema 

type Schema struct {
	Name             string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	DatasourceType   DatasourceType `` /* 146-byte string literal not displayed */
	Fields           []*SchemaField `protobuf:"bytes,3,rep,name=fields,proto3" json:"fields,omitempty"`
	TableDescription string         `protobuf:"bytes,4,opt,name=table_description,json=tableDescription,proto3" json:"table_description,omitempty"`
	// contains filtered or unexported fields
}

Schema is a schema for a datasource.

func (*Schema) Descriptor deprecated 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetDatasourceType 

func (x *Schema) GetDatasourceType() DatasourceType

func (*Schema) GetFields 

func (x *Schema) GetFields() []*SchemaField

func (*Schema) GetName 

func (x *Schema) GetName() string

func (*Schema) GetTableDescription added in v1.8.13 

func (x *Schema) GetTableDescription() string

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset 

func (x *Schema) Reset()

func (*Schema) String 

func (x *Schema) String() string

type SchemaField 

type SchemaField struct {
	Name              string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	ColumnType        SchemaType `` /* 130-byte string literal not displayed */
	IsPrimaryKey      bool       `protobuf:"varint,3,opt,name=is_primary_key,json=isPrimaryKey,proto3" json:"is_primary_key,omitempty"`
	IsLowCardinality  bool       `protobuf:"varint,4,opt,name=is_low_cardinality,json=isLowCardinality,proto3" json:"is_low_cardinality,omitempty"`
	ColumnDescription string     `protobuf:"bytes,5,opt,name=column_description,json=columnDescription,proto3" json:"column_description,omitempty"`
	// contains filtered or unexported fields
}

SchemaField is a field in a schema.

func (*SchemaField) Descriptor deprecated 

func (*SchemaField) Descriptor() ([]byte, []int)

Deprecated: Use SchemaField.ProtoReflect.Descriptor instead.

func (*SchemaField) GetColumnDescription added in v1.8.13 

func (x *SchemaField) GetColumnDescription() string

func (*SchemaField) GetColumnType 

func (x *SchemaField) GetColumnType() SchemaType

func (*SchemaField) GetIsLowCardinality 

func (x *SchemaField) GetIsLowCardinality() bool

func (*SchemaField) GetIsPrimaryKey 

func (x *SchemaField) GetIsPrimaryKey() bool

func (*SchemaField) GetName 

func (x *SchemaField) GetName() string

func (*SchemaField) ProtoMessage 

func (*SchemaField) ProtoMessage()

func (*SchemaField) ProtoReflect 

func (x *SchemaField) ProtoReflect() protoreflect.Message

func (*SchemaField) Reset 

func (x *SchemaField) Reset()

func (*SchemaField) String 

func (x *SchemaField) String() string

type SchemaType 

type SchemaType int32

SchemaType is an enum for the type of a schema field. 

const (
	SchemaType_SCHEMA_TYPE_UNSPECIFIED  SchemaType = 0
	SchemaType_SCHEMA_TYPE_INT          SchemaType = 2
	SchemaType_SCHEMA_TYPE_FLOAT        SchemaType = 3
	SchemaType_SCHEMA_TYPE_STRING       SchemaType = 5
	SchemaType_SCHEMA_TYPE_BOOL         SchemaType = 6
	SchemaType_SCHEMA_TYPE_TIMESTAMP    SchemaType = 7
	SchemaType_SCHEMA_TYPE_INT_ARRAY    SchemaType = 8
	SchemaType_SCHEMA_TYPE_FLOAT_ARRAY  SchemaType = 9
	SchemaType_SCHEMA_TYPE_STRING_ARRAY SchemaType = 10
	SchemaType_SCHEMA_TYPE_BOOL_ARRAY   SchemaType = 11
	SchemaType_SCHEMA_TYPE_MAP          SchemaType = 12
)

func (SchemaType) Descriptor 

func (SchemaType) Descriptor() protoreflect.EnumDescriptor

func (SchemaType) Enum 

func (x SchemaType) Enum() *SchemaType

func (SchemaType) EnumDescriptor deprecated 

func (SchemaType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SchemaType.Descriptor instead.

func (SchemaType) Number 

func (x SchemaType) Number() protoreflect.EnumNumber

func (SchemaType) String 

func (x SchemaType) String() string

func (SchemaType) Type 

func (SchemaType) Type() protoreflect.EnumType

type UnimplementedExplorerServiceServer 

type UnimplementedExplorerServiceServer struct{}

UnimplementedExplorerServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedExplorerServiceServer) ListDatasourceSchemas 

func (UnimplementedExplorerServiceServer) ListDatasourceSchemas(context.Context, *ListDatasourceSchemasRequest) (*ListDatasourceSchemasResponse, error)

func (UnimplementedExplorerServiceServer) Query 

func (UnimplementedExplorerServiceServer) Query(context.Context, *QueryRequest) (*QueryResponse, error)

type UnsafeExplorerServiceServer 

type UnsafeExplorerServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeExplorerServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExplorerServiceServer will result in compilation errors.

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.