github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/transform/startf/ds/doc.go (about)

     1  /*Package ds defines the qri dataset object within starlark
     2  
     3    outline: ds
     4      ds defines the qri dataset object within starlark. it's loaded by default
     5      in the qri runtime
     6  
     7      types:
     8        Dataset
     9          a qri dataset. Datasets can be either read-only or read-write. By default datasets are read-write
    10          methods:
    11            set_meta(meta dict)
    12              set dataset meta component
    13            get_meta() dict|None
    14              get dataset meta component
    15            get_structure() dict|None
    16              get dataset structure component if one is defined
    17            set_structure(structure) structure
    18              set dataset structure component
    19            get_body() dict|list|None
    20              get dataset body component if one is defined
    21            set_body(data dict|list, parse_as? string) body
    22              set dataset body component. set_body has only one optional argument: 'parse_as', which defaults to the
    23              empty string. By default qri assumes the data value provided to set_body is an iterable starlark data
    24              structure (tuple, set, list, dict). When parse_as is set, set_body assumes the provided body value will
    25              be a string of serialized structured data in the given format. valid parse_as values are "json", "csv",
    26              "cbor", "xlsx".
    27  */
    28  package ds