JuliaDB.jl icon indicating copy to clipboard operation
JuliaDB.jl copied to clipboard

documentation of save table is missing

Open xiuliren opened this issue 6 years ago • 1 comments

the saving of table works, but I did not find any documentation. JuliaDB.save(db, "path/of/db") works without documentation.

help?> JuliaDB.save
  save(io::IO, val)

  Save a value into the IO buffer. In the case of arrays and sparse matrices, this will save it in a memory-mappable way.

  load(io::IO, t::Type, domain) will load the object given its domain

  ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

  save(ctx, chunk::Union{Chunk, Thunk}, file_path::AbsractString)

  Save a chunk to a file at file_path.

  ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

  special case distmem writing - write to disk on the process with the chunk.

  ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

  save(t::Union{DNDSparse, DNDSparse}, outputdir::AbstractString)

  Saves a distributed dataset to disk. Saved data can be loaded with load.

xiuliren avatar Nov 16 '18 14:11 xiuliren

It's in the "Loading and Saving" section of the docs:

http://juliadb.org/latest/api/io.html#Save-and-Load-blobs-1

I'll leave this issue open, since the docstring should be improved to mention the non-distributed versions of tables.

joshday avatar Nov 16 '18 14:11 joshday