dataset

package module

Go to main page

Versions in this module

v2

v2.1.23

Oct 24, 2024

Changes in this version

type Config

+ FailPage string

+ SuccessPage string

v2.1.22

Oct 8, 2024

v2.1.21

Oct 3, 2024

Changes in this version

type Collection

+ Model *models.Model

type Config

+ Model *models.Model

v2.1.19

Sep 19, 2024

v2.1.18

Sep 10, 2024

Changes in this version

+ func MakeYAML(src []byte, attributes []string) ([]byte, error)

type DSQuery

+ AsYAML bool

v2.1.13

Jun 12, 2024

Changes in this version

+ func Query(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

type API

+ Debug bool

type Config

+ QueryFn map[string]string

type Settings

+ func (settings *Settings) GetCfg(cName string) (*Config, error)

v2.1.11

Jun 11, 2024

Changes in this version

+ func YAMLMarshal(data interface{}) ([]byte, error)

+ func YAMLMarshalIndent(data interface{}, spaces int) ([]byte, error)

+ func YAMLUnmarshal(src []byte, data interface{}) error

v2.1.10

Feb 27, 2024

v2.1.9

Oct 13, 2023

v2.1.8

Oct 9, 2023

v2.1.7

Oct 2, 2023

Changes in this version

+ type DSImport struct

+ Comma string

+ Comment string

+ LazyQuotes bool

+ Overwrite bool

+ TrimLeadingSpace bool

+ func (app *DSImport) Run(in io.Reader, out io.Writer, eout io.Writer, cName string, keyColumn string) error

v2.1.6

Sep 29, 2023

Changes in this version

+ func MakeCSV(src []byte, attributes []string) ([]byte, error)

type DSQuery

+ AsCSV bool

v2.1.5

Sep 29, 2023

Changes in this version

+ func MakeGrid(src []byte, attributes []string) ([]byte, error)

type DSQuery

+ AsGrid bool

+ Attributes []string

+ PTIndex bool

v2.1.4

Sep 27, 2023

Changes in this version

+ func JSONIndent(src []byte, prefix string, indent string) []byte

+ type DSQuery struct

+ CName string

+ Pretty bool

+ Stmt string

+ func (app *DSQuery) Run(in io.Reader, out io.Writer, eout io.Writer, cName string, stmt string, ...) error

v2.1.3

Sep 26, 2023

Changes in this version

+ const ReleaseDate

+ const ReleaseHash

+ func FmtHelp(src string, appName string, version string, releaseDate string, ...) string

v2.1.2

Sep 20, 2023

Changes in this version

+ func JSONMarshal(data interface{}) ([]byte, error)

+ func JSONMarshalIndent(data interface{}, prefix string, indent string) ([]byte, error)

+ func JSONUnmarshal(src []byte, data interface{}) error

v2.1.1

Feb 15, 2023

Changes in this version

type Collection

+ func (c *Collection) ReadJSONVersion(key string, semver string) ([]byte, error)

v2.1.0

Feb 10, 2023

Changes in this version

+ const LicenseText

+ func RowInterfaceToString(r []interface{}) []string

+ func RowStringToInterface(r []string) []interface

+ func TableInterfaceToString(t [][]interface{}) [][]string

+ func TableStringToInterface(t [][]string) [][]interface

+ func ValueInterfaceToString(val interface{}) (string, error)

+ func ValueStringToInterface(s string) (interface{}, error)

type Collection

+ func (c *Collection) CreateObjectsJSON(keyList []string, src []byte) error

+ func (c *Collection) DocPath(key string) (string, error)

+ func (c *Collection) ExportCSV(fp io.Writer, eout io.Writer, f *DataFrame, verboseLog bool) (int, error)

+ func (c *Collection) ExportTable(eout io.Writer, f *DataFrame, verboseLog bool) (int, [][]interface{}, error)

+ func (c *Collection) ImportCSV(buf io.Reader, idCol int, skipHeaderRow bool, overwrite bool, verboseLog bool) (int, error)

+ func (c *Collection) ImportTable(table [][]interface{}, idCol int, useHeaderRow bool, ...) (int, error)

+ func (c *Collection) Join(key string, obj map[string]interface{}, overwrite bool) error

+ func (c *Collection) MergeFromTable(frameName string, table [][]interface{}, overwrite bool, verbose bool) error

+ func (c *Collection) MergeIntoTable(frameName string, table [][]interface{}, overwrite bool, verbose bool) ([][]interface{}, error)

v2.0.1

Dec 6, 2022

Changes in this version

+ const License

+ const Major

+ const Minor

+ const None

+ const PTSTORE

+ const Patch

+ const SQLSTORE

+ const Version

+ var EndPointAttach = ...

+ var EndPointCollection = ...

+ var EndPointCollections = ...

+ var EndPointDelete = ...

+ var EndPointDocument = ...

+ var EndPointKeys = ...

+ var EndPointPrune = ...

+ var EndPointREADME = ...

+ var EndPointRead = ...

+ var EndPointRetrieve = ...

+ var EndPointUpdate = ...

+ var WEBDescription = ...

+ var WebDescription = ...

+ var WebExamples = ...

+ func Analyzer(cName string, verbose bool) error

+ func ApiDisplayUsage(out io.Writer, appName string, flagSet *flag.FlagSet)

+ func ApiVersion(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func Attach(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func AttachmentVersions(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func Attachments(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func BytesProcessor(varMap map[string]string, text []byte) []byte

+ func CliDisplayHelp(in io.Reader, out io.Writer, eout io.Writer, args []string) error

+ func CliDisplayUsage(out io.Writer, appName string, flagSet *flag.FlagSet)

+ func Codemeta(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func Collections(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func Create(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func DecodeJSON(src []byte, obj *map[string]interface{}) error

+ func Delete(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func DeleteVersion(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func DisplayLicense(out io.Writer, appName string)

+ func DisplayVersion(out io.Writer, appName string)

+ func EncodeJSON(obj map[string]interface{}) ([]byte, error)

+ func FixMissingCollectionJson(cName string) error

+ func FrameCreate(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func FrameDef(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func FrameDelete(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func FrameKeys(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func FrameObjects(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func FrameUpdate(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func Frames(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func HasFrame(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func Keys(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func Migrate(srcName string, dstName string, verbose bool) error

+ func ObjectVersions(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func ParseDSN(uri string) (string, error)

+ func Prune(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func PruneVersion(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func Read(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func ReadKeys(keysName string, in io.Reader) ([]string, error)

+ func ReadSource(fName string, in io.Reader) ([]byte, error)

+ func ReadVersion(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func Repair(cName string, verbose bool) error

+ func Retrieve(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func RetrieveVersion(w http.ResponseWriter, r *http.Request, api *API, cName, verb string, ...)

+ func RunAPI(appName string, settingsFile string) error

+ func RunCLI(in io.Reader, out io.Writer, eout io.Writer, args []string) error

+ func SetupApiTestCollection(cName string, dsnURI string, records map[string]map[string]interface{}) error

+ func StringProcessor(varMap map[string]string, text string) string

+ func Update(w http.ResponseWriter, r *http.Request, api *API, cName string, verb string, ...)

+ func WriteKeys(keyFilename string, out io.Writer, keys []string) error

+ func WriteSource(fName string, out io.Writer, src []byte) error

+ type API struct

+ AppName string

+ CMap map[string]*Collection

+ Pid int

+ Routes map[string]map[string]func(http.ResponseWriter, *http.Request, *API, string, string, []string)

+ Settings *Settings

+ SettingsFile string

+ Version string

+ func (api *API) Init(appName string, settingsFile string) error

+ func (api *API) RegisterRoute(prefix string, method string, ...) error

+ func (api *API) Reload(sigName string) error

+ func (api *API) Router(w http.ResponseWriter, r *http.Request)

+ func (api *API) Shutdown(sigName string) int

+ func (api *API) WebService() error

+ type Attachment struct

+ Checksums map[string]string

+ Created string

+ HRef string

+ Metadata map[string]interface{}

+ Modified string

+ Name string

+ Size int64

+ Sizes map[string]int64

+ Version string

+ VersionHRefs map[string]string

+ type Collection struct

+ Created string

+ DatasetVersion string

+ DsnURI string

+ Name string

+ PTStore *PTStore

+ Repaired string

+ SQLStore *SQLStore

+ StoreType string

+ Versioning string

+ func Init(name string, dsnURI string) (*Collection, error)

+ func Open(name string) (*Collection, error)

+ func (c *Collection) AttachFile(key string, filename string) error

+ func (c *Collection) AttachStream(key string, filename string, buf io.Reader) error

+ func (c *Collection) AttachVersionFile(key string, filename string, version string) error

+ func (c *Collection) AttachVersionStream(key string, filename string, version string, buf io.Reader) error

+ func (c *Collection) AttachmentPath(key string, filename string) (string, error)

+ func (c *Collection) AttachmentVersionPath(key string, filename string, version string) (string, error)

+ func (c *Collection) AttachmentVersions(key string, filename string) ([]string, error)

+ func (c *Collection) Attachments(key string) ([]string, error)

+ func (c *Collection) Clone(cloneName string, cloneDsnURI string, keys []string, verbose bool) error

+ func (c *Collection) CloneSample(trainingName string, trainingDsnURI string, testName string, testDsnURI string, ...) error

+ func (c *Collection) Close() error

+ func (c *Collection) Codemeta() ([]byte, error)

+ func (c *Collection) Create(key string, obj map[string]interface{}) error

+ func (c *Collection) CreateJSON(key string, src []byte) error

+ func (c *Collection) CreateObject(key string, obj interface{}) error

+ func (c *Collection) Delete(key string) error

+ func (c *Collection) FrameClear(name string) error

+ func (c *Collection) FrameCreate(name string, keys []string, dotPaths []string, labels []string, verbose bool) (*DataFrame, error)

+ func (c *Collection) FrameDef(name string) (map[string]interface{}, error)

+ func (c *Collection) FrameDelete(name string) error

+ func (c *Collection) FrameKeys(name string) []string

+ func (c *Collection) FrameNames() []string

+ func (c *Collection) FrameObjects(fName string) ([]map[string]interface{}, error)

+ func (c *Collection) FrameRead(name string) (*DataFrame, error)

+ func (c *Collection) FrameReframe(name string, keys []string, verbose bool) error

+ func (c *Collection) FrameRefresh(name string, verbose bool) error

+ func (c *Collection) HasFrame(frameName string) bool

+ func (c *Collection) HasKey(key string) bool

+ func (c *Collection) Keys() ([]string, error)

+ func (c *Collection) Length() int64

+ func (c *Collection) ObjectList(keys []string, dotPaths []string, labels []string, verbose bool) ([]map[string]interface{}, error)

+ func (c *Collection) Prune(key string, filename string) error

+ func (c *Collection) PruneAll(key string) error

+ func (c *Collection) PruneVersion(key string, filename string, version string) error

+ func (c *Collection) Read(key string, obj map[string]interface{}) error

+ func (c *Collection) ReadJSON(key string) ([]byte, error)

+ func (c *Collection) ReadObject(key string, obj interface{}) error

+ func (c *Collection) ReadObjectVersion(key string, version string, obj interface{}) error

+ func (c *Collection) ReadVersion(key string, version string, obj map[string]interface{}) error

+ func (c *Collection) RetrieveFile(key string, filename string) ([]byte, error)

+ func (c *Collection) RetrieveStream(key string, filename string, out io.Writer) error

+ func (c *Collection) RetrieveVersionFile(key string, filename string, version string) ([]byte, error)

+ func (c *Collection) RetrieveVersionStream(key string, filename string, version string, buf io.Writer) error

+ func (c *Collection) Sample(size int) ([]string, error)

+ func (c *Collection) SaveFrame(name string, f *DataFrame) error

+ func (c *Collection) SetVersioning(versioning string) error

+ func (c *Collection) Update(key string, obj map[string]interface{}) error

+ func (c *Collection) UpdateJSON(key string, src []byte) error

+ func (c *Collection) UpdateMetadata(fName string) error

+ func (c *Collection) UpdateObject(key string, obj interface{}) error

+ func (c *Collection) UpdatedKeys(start string, end string) ([]string, error)

+ func (c *Collection) Versions(key string) ([]string, error)

+ func (c *Collection) WorkPath() string

+ type Config struct

+ Attach bool

+ Attachments bool

+ CName string

+ Create bool

+ Delete bool

+ DsnURI string

+ FrameRead bool

+ FrameWrite bool

+ Keys bool

+ Prune bool

+ Read bool

+ Retrieve bool

+ Update bool

+ Versions bool

+ type DataFrame struct

+ CollectionName string

+ Created time.Time

+ DotPaths []string

+ Keys []string

+ Labels []string

+ Name string

+ ObjectMap map[string]interface{}

+ Updated time.Time

+ func (f *DataFrame) Grid(includeHeaderRow bool) [][]interface{}

+ func (f *DataFrame) Objects() []map[string]interface{}

+ func (f *DataFrame) String() string

+ type PTStore struct

+ Versioning int

+ WorkPath string

+ func PTStoreOpen(name string, dsnURI string) (*PTStore, error)

+ func (store *PTStore) Close() error

+ func (store *PTStore) Create(key string, src []byte) error

+ func (store *PTStore) Delete(key string) error

+ func (store *PTStore) DocPath(key string) (string, error)

+ func (store *PTStore) HasKey(key string) bool

+ func (store *PTStore) Keymap() map[string]string

+ func (store *PTStore) KeymapName() string

+ func (store *PTStore) Keys() ([]string, error)

+ func (store *PTStore) Length() int64

+ func (store *PTStore) Read(key string) ([]byte, error)

+ func (store *PTStore) ReadVersion(key string, version string) ([]byte, error)

+ func (store *PTStore) SetVersioning(setting int) error

+ func (store *PTStore) Update(key string, src []byte) error

+ func (store *PTStore) UpdateKeymap(keymap map[string]string) error

+ func (store *PTStore) Versions(key string) ([]string, error)

+ type SQLStore struct

+ Versioning int

+ WorkPath string

+ func SQLStoreInit(name string, dsnURI string) (*SQLStore, error)

+ func SQLStoreOpen(name string, dsnURI string) (*SQLStore, error)

+ func (store *SQLStore) Close() error

+ func (store *SQLStore) Create(key string, src []byte) error

+ func (store *SQLStore) Delete(key string) error

+ func (store *SQLStore) HasKey(key string) bool

+ func (store *SQLStore) Keys() ([]string, error)

+ func (store *SQLStore) Length() int64

+ func (store *SQLStore) Read(key string) ([]byte, error)

+ func (store *SQLStore) ReadVersion(key string, version string) ([]byte, error)

+ func (store *SQLStore) SetVersioning(setting int) error

+ func (store *SQLStore) Update(key string, src []byte) error

+ func (store *SQLStore) UpdatedKeys(start string, end string) ([]string, error)

+ func (store *SQLStore) Versions(key string) ([]string, error)

+ type Settings struct

+ Collections []*Config

+ Host string

+ Htdocs string

+ func ConfigOpen(fName string) (*Settings, error)

+ func (settings *Settings) String() string

+ func (settings *Settings) WriteFile(name string, perm os.FileMode) error

+ type StorageSystem interface

+ Close func() error

+ Create func(string, []byte) error

+ Delete func(string) error

+ HasKey func(string) bool

+ Keys func() ([]string, error)

+ Length func() int64

+ Open func(name string, dsnURI string) (*StorageSystem, error)

+ Read func(string) ([]byte, error)

+ ReadVersion func(string, string) ([]byte, error)

+ Update func(string, []byte) error

+ Versions func(string) ([]string, error)

v2.0.0-b06

Aug 22, 2022

v2.0.0-b05

Aug 17, 2022

v2.0.0-b01

Jul 14, 2022

v2.0.0-a9

Jul 12, 2022

v2.0.0-a7

Jun 30, 2022

v2.0.0-a6

Jun 30, 2022

v2.0.0-a5

Jun 30, 2022

v2.0.0-a4

Jun 30, 2022

v2.0.0-a3

Jun 30, 2022

v2.0.0-a2

Jun 24, 2022

v2.0.0-a11

Jul 13, 2022

v2.0.0-a10

Jul 13, 2022

v2.0.0-a1

Jun 24, 2022

Other modules containing this package

github.com/caltechlibrary/dataset

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