dataset

package module

Go to main page

Versions in this module

v0

v0.3.0

May 4, 2021

Changes in this version

+ const KindBody

+ const KindStats

+ var ErrNoBody = fmt.Errorf("dataset has no body component")

+ func ComponentTypePrefix(k Kind, str string) string

type Commit

+ RunID string

type Dataset

+ ID string

+ Stats *Stats

+ func (ds *Dataset) PathMap(ignore ...string) map[string]string

+ func (ds *Dataset) SigningBytes() []byte

type Readme

+ func (r *Readme) ShallowCompare(b *Readme) bool

+ type Stats struct

+ Path string

+ Qri string

+ Stats interface{}

+ func NewStatsRef(path string) *Stats

+ func (sa *Stats) Assign(sas ...*Stats)

+ func (sa *Stats) DropDerivedValues()

+ func (sa *Stats) IsEmpty() bool

+ func (sa *Stats) UnmarshalJSON(data []byte) error

+ func (sa Stats) MarshalJSON() ([]byte, error)

+ func (sa Stats) MarshalJSONObject() ([]byte, error)

type Transform

+ Steps []*TransformStep

+ Syntaxes map[string]string

+ func (q *Transform) ShallowCompare(b *Transform) bool

+ type TransformStep struct

+ Category string

+ Name string

+ Path string

+ Script interface{}

+ Syntax string

type Viz

+ func (v *Viz) ShallowCompare(b *Viz) bool

v0.2.0

Jun 29, 2020

Changes in this version

+ const KindReadme

type Dataset

+ Readme *Readme

+ type Readme struct

+ Format string

+ Path string

+ Qri string

+ RenderedPath string

+ ScriptBytes []byte

+ ScriptPath string

+ func NewReadmeRef(path string) *Readme

+ func UnmarshalReadme(v interface{}) (*Readme, error)

+ func (r *Readme) Assign(readmeConfigs ...*Readme)

+ func (r *Readme) DropDerivedValues()

+ func (r *Readme) DropTransientValues()

+ func (r *Readme) InlineScriptFile(ctx context.Context, resolver qfs.PathResolver) error

+ func (r *Readme) IsEmpty() bool

+ func (r *Readme) MarshalJSON() ([]byte, error)

+ func (r *Readme) MarshalJSONObject() ([]byte, error)

+ func (r *Readme) OpenRenderedFile(ctx context.Context, resolver qfs.PathResolver) (err error)

+ func (r *Readme) OpenScriptFile(ctx context.Context, resolver qfs.PathResolver) (err error)

+ func (r *Readme) RenderedFile() qfs.File

+ func (r *Readme) ScriptFile() qfs.File

+ func (r *Readme) SetRenderedFile(file qfs.File)

+ func (r *Readme) SetScriptFile(file qfs.File)

+ func (r *Readme) UnmarshalJSON(data []byte) error

type Structure

+ func (s *Structure) RequiresTabularSchema() bool

type Transform

+ func (q *Transform) InlineScriptFile(ctx context.Context, resolver qfs.PathResolver) error

v0.1.4

Sep 4, 2019

Changes in this version

type Commit

+ func (cm *Commit) DropDerivedValues()

type Dataset

+ func (ds *Dataset) DropDerivedValues()

type JSONOptions

+ Options map[string]interface{}

type Meta

+ func (md *Meta) DropDerivedValues()

type Structure

+ func (s *Structure) DropDerivedValues()

type Transform

+ func (q *Transform) DropDerivedValues()

type Viz

+ func (v *Viz) DropDerivedValues()

v0.1.2

Jun 10, 2019

v0.1.1

Jun 3, 2019

v0.1.0

Jun 3, 2019

Changes in this version

+ const CurrentSpecVersion

+ const KindCommit

+ const KindDataset

+ const KindMeta

+ const KindStructure

+ const KindTransform

+ const KindViz

+ var BaseSchemaArray = map[string]interface

+ var BaseSchemaObject = map[string]interface

+ var ErrInlineBody = fmt.Errorf("dataset body is inlined")

+ var ErrNoResolver = fmt.Errorf("no resolver available to fetch path")

+ var ErrUnknownDataFormat = fmt.Errorf("Unknown Data Format")

+ func AbstractColumnName(i int) string

+ func AccuralDuration(p string) time.Duration

+ func CompareCommits(a, b *Commit) error

+ func CompareDatasets(a, b *Dataset) error

+ func CompareLicenses(a, b *License) error

+ func CompareMetas(a, b *Meta) error

+ func CompareSchemas(a, b map[string]interface{}) error

+ func CompareStringSlices(a, b []string) error

+ func CompareStructures(a, b *Structure) error

+ func CompareTransformResources(a, b *TransformResource) error

+ func CompareTransforms(a, b *Transform) error

+ func CompareVizs(a, b *Viz) error

+ func HashBytes(data []byte) (hash string, err error)

+ func JSONHash(m json.Marshaler) (hash string, err error)

+ type CSVOptions struct

+ HeaderRow bool

+ LazyQuotes bool

+ Separator rune

+ VariadicFields bool

+ func NewCSVOptions(opts map[string]interface{}) (*CSVOptions, error)

+ func (*CSVOptions) Format() DataFormat

+ func (o *CSVOptions) Map() map[string]interface{}

+ type Citation struct

+ Email string

+ Name string

+ URL string

+ func (c *Citation) Decode(val interface{}) (err error)

+ type Commit struct

+ Author *User

+ Message string

+ Path string

+ Qri string

+ Signature string

+ Timestamp time.Time

+ Title string

+ func NewCommitRef(path string) *Commit

+ func UnmarshalCommit(v interface{}) (*Commit, error)

+ func (cm *Commit) Assign(msgs ...*Commit)

+ func (cm *Commit) DropTransientValues()

+ func (cm *Commit) IsEmpty() bool

+ func (cm *Commit) MarshalJSON() ([]byte, error)

+ func (cm *Commit) MarshalJSONObject() ([]byte, error)

+ func (cm *Commit) UnmarshalJSON(data []byte) error

+ type DataFormat int

+ const CBORDataFormat

+ const CSVDataFormat

+ const JSONDataFormat

+ const UnknownDataFormat

+ const XLSXDataFormat

+ const XMLDataFormat

+ func ParseDataFormatString(s string) (df DataFormat, err error)

+ func SupportedDataFormats() []DataFormat

+ func (f *DataFormat) UnmarshalJSON(data []byte) error

+ func (f DataFormat) MarshalJSON() ([]byte, error)

+ func (f DataFormat) String() string

+ type Dataset struct

+ Body interface{}

+ BodyBytes []byte

+ BodyPath string

+ Commit *Commit

+ Meta *Meta

+ Name string

+ NumVersions int

+ Path string

+ Peername string

+ PreviousPath string

+ ProfileID string

+ Qri string

+ Structure *Structure

+ Transform *Transform

+ Viz *Viz

+ func NewDatasetRef(path string) *Dataset

+ func UnmarshalDataset(v interface{}) (*Dataset, error)

+ func (ds *Dataset) Assign(datasets ...*Dataset)

+ func (ds *Dataset) BodyFile() qfs.File

+ func (ds *Dataset) DropTransientValues()

+ func (ds *Dataset) IsEmpty() bool

+ func (ds *Dataset) MarshalJSON() ([]byte, error)

+ func (ds *Dataset) OpenBodyFile(resolver qfs.PathResolver) (err error)

+ func (ds *Dataset) SetBodyFile(file qfs.File)

+ func (ds *Dataset) SignableBytes() ([]byte, error)

+ func (ds *Dataset) UnmarshalJSON(data []byte) error

+ type FormatConfig interface

+ Format func() DataFormat

+ Map func() map[string]interface{}

+ func NewXLSXOptions(opts map[string]interface{}) (FormatConfig, error)

+ func ParseFormatConfigMap(f DataFormat, opts map[string]interface{}) (FormatConfig, error)

+ type JSONOptions struct

+ func NewJSONOptions(opts map[string]interface{}) (*JSONOptions, error)

+ func (*JSONOptions) Format() DataFormat

+ func (o *JSONOptions) Map() map[string]interface{}

+ type Kind string

+ func (k *Kind) UnmarshalJSON(data []byte) error

+ func (k Kind) String() string

+ func (k Kind) Type() string

+ func (k Kind) Valid() error

+ func (k Kind) Version() string

+ type License struct

+ Type string

+ URL string

+ func (l *License) Decode(val interface{}) (err error)

+ type Meta struct

+ AccessURL string

+ AccrualPeriodicity string

+ Citations []*Citation

+ Contributors []*User

+ Description string

+ DownloadURL string

+ HomeURL string

+ Identifier string

+ Keywords []string

+ Language []string

+ License *License

+ Path string

+ Qri string

+ ReadmeURL string

+ Theme []string

+ Title string

+ Version string

+ func NewMetaRef(path string) *Meta

+ func UnmarshalMeta(v interface{}) (*Meta, error)

+ func (md *Meta) Assign(metas ...*Meta)

+ func (md *Meta) DropTransientValues()

+ func (md *Meta) IsEmpty() bool

+ func (md *Meta) MarshalJSON() ([]byte, error)

+ func (md *Meta) MarshalJSONObject() ([]byte, error)

+ func (md *Meta) Meta() map[string]interface{}

+ func (md *Meta) Set(key string, val interface{}) (err error)

+ func (md *Meta) SetArbitrary(key string, val interface{}) (err error)

+ func (md *Meta) UnmarshalJSON(data []byte) error

+ type Structure struct

+ Checksum string

+ Compression string

+ Depth int

+ Encoding string

+ Entries int

+ ErrCount int

+ Format string

+ FormatConfig map[string]interface{}

+ Length int

+ Path string

+ Qri string

+ Schema map[string]interface{}

+ Strict bool

+ func NewStructureRef(path string) *Structure

+ func UnmarshalStructure(v interface{}) (*Structure, error)

+ func (s *Structure) Abstract() *Structure

+ func (s *Structure) Assign(structures ...*Structure)

+ func (s *Structure) DataFormat() DataFormat

+ func (s *Structure) DropTransientValues()

+ func (s *Structure) Hash() (string, error)

+ func (s *Structure) IsEmpty() bool

+ func (s *Structure) JSONSchema() (*jsonschema.RootSchema, error)

+ func (s *Structure) UnmarshalJSON(data []byte) (err error)

+ func (s Structure) MarshalJSON() (data []byte, err error)

+ func (s Structure) MarshalJSONObject() ([]byte, error)

+ type Theme struct

+ Description string

+ DisplayName string

+ ID string

+ ImageDisplayURL string

+ Name string

+ Title string

+ type Transform struct

+ Config map[string]interface{}

+ Path string

+ Qri string

+ Resources map[string]*TransformResource

+ ScriptBytes []byte

+ ScriptPath string

+ Secrets map[string]string

+ Syntax string

+ SyntaxVersion string

+ func NewTransformRef(path string) *Transform

+ func UnmarshalTransform(v interface{}) (*Transform, error)

+ func (q *Transform) Assign(qs ...*Transform)

+ func (q *Transform) DropTransientValues()

+ func (q *Transform) IsEmpty() bool

+ func (q *Transform) OpenScriptFile(resolver qfs.PathResolver) (err error)

+ func (q *Transform) ScriptFile() qfs.File

+ func (q *Transform) SetScriptFile(file qfs.File)

+ func (q *Transform) UnmarshalJSON(data []byte) error

+ func (q Transform) MarshalJSON() ([]byte, error)

+ func (q Transform) MarshalJSONObject() ([]byte, error)

+ type TransformResource struct

+ Path string

+ func (r *TransformResource) UnmarshalJSON(data []byte) error

+ type User struct

+ Email string

+ Fullname string

+ ID string

+ func (u *User) Decode(val interface{}) (err error)

+ type Viz struct

+ Format string

+ Path string

+ Qri string

+ RenderedPath string

+ ScriptBytes []byte

+ ScriptPath string

+ func NewVizRef(path string) *Viz

+ func UnmarshalViz(v interface{}) (*Viz, error)

+ func (v *Viz) Assign(visConfigs ...*Viz)

+ func (v *Viz) DropTransientValues()

+ func (v *Viz) IsEmpty() bool

+ func (v *Viz) MarshalJSON() ([]byte, error)

+ func (v *Viz) MarshalJSONObject() ([]byte, error)

+ func (v *Viz) OpenRenderedFile(resolver qfs.PathResolver) (err error)

+ func (v *Viz) OpenScriptFile(resolver qfs.PathResolver) (err error)

+ func (v *Viz) RenderedFile() qfs.File

+ func (v *Viz) ScriptFile() qfs.File

+ func (v *Viz) SetRenderedFile(file qfs.File)

+ func (v *Viz) SetScriptFile(file qfs.File)

+ func (v *Viz) UnmarshalJSON(data []byte) error

+ type XLSXOptions struct

+ SheetName string

+ func (*XLSXOptions) Format() DataFormat

+ func (o *XLSXOptions) Map() map[string]interface{}

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