table_streamer: Define an object of class 'tablestreamer' that defines...

Description Usage Arguments Value

View source: R/table_streamer.R

Description

Define an object of class 'tablestreamer' that defines specific methods for serializing of datasets

Usage

1
2
3
4
5
6
7
8
9
table_streamer(
  id,
  table_writer,
  table_reader,
  can_select_threads = FALSE,
  variable_compression = FALSE,
  set_threads = NULL,
  custom_parameters = NULL
)

Arguments

id

ID of the table streamer (e.g. 'fst' or 'parguet')

table_writer

method for writing with signature f(x, file_name, compress, threads, custom_parameters). Parameter compression should be a percentage (0.0 to 100.0).

table_reader

method for reading with signature f(file_name, threads, custom_parameters).

can_select_threads

TRUE of FALSE depending on the ability to select the number of threads

variable_compression

TRUE of FALSE depending on the ability to select compression

set_threads

method for specifying the number of threads to use for (de-) serialization, the signature must be f(nr_of_threads, custom_parameters).

custom_parameters

Additional parameters that are needed for the streamer

Value

a tablestreamer object


fstpackage/syntheticbench documentation built on Jan. 23, 2020, 10:13 a.m.