preview

Documentation

Index

• Constants
• func Create(ctx context.Context, ds *dataset.Dataset) (*dataset.Dataset, error)

Constants

const (
	// MaxNumDatasetRowsInPreview is the highest number of rows a dataset preview
	// can contain
	MaxNumDatasetRowsInPreview = 100
	// MaxReadmePreviewBytes determines the maximum amount of bytes a readme
	// preview can be. three bytes less than 1000 to make room for an elipsis
	MaxReadmePreviewBytes = 997
)

Functions

func Create

func Create(ctx context.Context, ds *dataset.Dataset) (*dataset.Dataset, error)

Create generates a preview for a dataset version It expects the passed in dataset to have any relevant script files already loaded Preview currently includes:

• body: 100 rows
• readme: first 997 bytes
• meta: all
• commit: all
• structure: all
• stats: none
• viz: all
• transform: all