dataset

package
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Jun 12, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateDatasetFile added in v0.5.1

type CreateDatasetFile struct {
	Name   string
	Reader io.Reader
}

type CreateDatasetRequest

type CreateDatasetRequest struct {
	Name        string              `json:"name"`
	Description string              `json:"description"`
	Type        db_dataset.Type     `json:"type"`
	Data        []string            `json:"data"`  // for list type
	Files       []CreateDatasetFile `json:"files"` // for csv type
}

type DatasetAPIRequest

type DatasetAPIRequest struct {
	Name        string                  `form:"name"`
	Description string                  `form:"description"`
	Type        string                  `form:"type"`
	Data        []string                `form:"data"`
	Files       []*multipart.FileHeader `form:"files"`
}

DatasetAPIRequest is used for API calls where files are base64 encoded strings

type DatasetInfo

type DatasetInfo struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Type        string `json:"type"`
	ColumnCount int    `json:"column_count"`
	ValueCount  int    `json:"value_count"`
	// for list type, data is the available options
	// for files type, data is the files in the dataset dir
	Data    []string `json:"data"`
	Columns []string `json:"columns"`
}

type DatasetRows

type DatasetRows struct {
	Rows []map[string]any `json:"rows"`
	Data []string         `json:"data"`
	Type db_dataset.Type  `json:"type"`
}

type DatasetService

type DatasetService interface {
	Get(ctx context.Context, source string) (*DatasetInfo, error)
	List(ctx context.Context) ([]*DatasetInfo, error)
	Create(ctx context.Context, req *CreateDatasetRequest) (string, error)
	Update(ctx context.Context, dataset string, req *UpdateDatasetRequest) error
	Delete(ctx context.Context, dataset string) error
	Preview(ctx context.Context, source string) (*DatasetRows, error)
}

type DatasetServiceImpl

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

func NewDatasetService

func NewDatasetService(db *ent.Client, cfg *config.Config) *DatasetServiceImpl

func (*DatasetServiceImpl) Create

func (*DatasetServiceImpl) Delete

func (s *DatasetServiceImpl) Delete(ctx context.Context, dataset string) error

func (*DatasetServiceImpl) Get

func (s *DatasetServiceImpl) Get(ctx context.Context, source string) (*DatasetInfo, error)

func (*DatasetServiceImpl) List

func (s *DatasetServiceImpl) List(ctx context.Context) ([]*DatasetInfo, error)

func (*DatasetServiceImpl) Preview

func (s *DatasetServiceImpl) Preview(ctx context.Context, dataset string) (*DatasetRows, error)

preview source data, csv will show top 100 rows and list will show all data

func (*DatasetServiceImpl) Update

func (s *DatasetServiceImpl) Update(ctx context.Context, dataset string, req *UpdateDatasetRequest) error

type DatasetServiceMock

type DatasetServiceMock struct {
	// CreateFunc mocks the Create method.
	CreateFunc func(ctx context.Context, req *CreateDatasetRequest) (string, error)

	// DeleteFunc mocks the Delete method.
	DeleteFunc func(ctx context.Context, dataset string) error

	// GetFunc mocks the Get method.
	GetFunc func(ctx context.Context, source string) (*DatasetInfo, error)

	// ListFunc mocks the List method.
	ListFunc func(ctx context.Context) ([]*DatasetInfo, error)

	// PreviewFunc mocks the Preview method.
	PreviewFunc func(ctx context.Context, source string) (*DatasetRows, error)

	// UpdateFunc mocks the Update method.
	UpdateFunc func(ctx context.Context, dataset string, req *UpdateDatasetRequest) error
	// contains filtered or unexported fields
}

DatasetServiceMock is a mock implementation of DatasetService.

func TestSomethingThatUsesDatasetService(t *testing.T) {

	// make and configure a mocked DatasetService
	mockedDatasetService := &DatasetServiceMock{
		CreateFunc: func(ctx context.Context, req *CreateDatasetRequest) (string, error) {
			panic("mock out the Create method")
		},
		DeleteFunc: func(ctx context.Context, dataset string) error {
			panic("mock out the Delete method")
		},
		GetFunc: func(ctx context.Context, source string) (*DatasetInfo, error) {
			panic("mock out the Get method")
		},
		ListFunc: func(ctx context.Context) ([]*DatasetInfo, error) {
			panic("mock out the List method")
		},
		PreviewFunc: func(ctx context.Context, source string) (*DatasetRows, error) {
			panic("mock out the Preview method")
		},
		UpdateFunc: func(ctx context.Context, dataset string, req *UpdateDatasetRequest) error {
			panic("mock out the Update method")
		},
	}

	// use mockedDatasetService in code that requires DatasetService
	// and then make assertions.

}

func (*DatasetServiceMock) Create

Create calls CreateFunc.

func (*DatasetServiceMock) CreateCalls

func (mock *DatasetServiceMock) CreateCalls() []struct {
	Ctx context.Context
	Req *CreateDatasetRequest
}

CreateCalls gets all the calls that were made to Create. Check the length with:

len(mockedDatasetService.CreateCalls())

func (*DatasetServiceMock) Delete

func (mock *DatasetServiceMock) Delete(ctx context.Context, dataset string) error

Delete calls DeleteFunc.

func (*DatasetServiceMock) DeleteCalls

func (mock *DatasetServiceMock) DeleteCalls() []struct {
	Ctx     context.Context
	Dataset string
}

DeleteCalls gets all the calls that were made to Delete. Check the length with:

len(mockedDatasetService.DeleteCalls())

func (*DatasetServiceMock) Get

func (mock *DatasetServiceMock) Get(ctx context.Context, source string) (*DatasetInfo, error)

Get calls GetFunc.

func (*DatasetServiceMock) GetCalls

func (mock *DatasetServiceMock) GetCalls() []struct {
	Ctx    context.Context
	Source string
}

GetCalls gets all the calls that were made to Get. Check the length with:

len(mockedDatasetService.GetCalls())

func (*DatasetServiceMock) List

func (mock *DatasetServiceMock) List(ctx context.Context) ([]*DatasetInfo, error)

List calls ListFunc.

func (*DatasetServiceMock) ListCalls

func (mock *DatasetServiceMock) ListCalls() []struct {
	Ctx context.Context
}

ListCalls gets all the calls that were made to List. Check the length with:

len(mockedDatasetService.ListCalls())

func (*DatasetServiceMock) Preview

func (mock *DatasetServiceMock) Preview(ctx context.Context, source string) (*DatasetRows, error)

Preview calls PreviewFunc.

func (*DatasetServiceMock) PreviewCalls

func (mock *DatasetServiceMock) PreviewCalls() []struct {
	Ctx    context.Context
	Source string
}

PreviewCalls gets all the calls that were made to Preview. Check the length with:

len(mockedDatasetService.PreviewCalls())

func (*DatasetServiceMock) Update

func (mock *DatasetServiceMock) Update(ctx context.Context, dataset string, req *UpdateDatasetRequest) error

Update calls UpdateFunc.

func (*DatasetServiceMock) UpdateCalls

func (mock *DatasetServiceMock) UpdateCalls() []struct {
	Ctx     context.Context
	Dataset string
	Req     *UpdateDatasetRequest
}

UpdateCalls gets all the calls that were made to Update. Check the length with:

len(mockedDatasetService.UpdateCalls())

type UpdateDatasetRequest

type UpdateDatasetRequest struct {
	CreateDatasetRequest
	Fields []string `json:"fields"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL