operations
create.database.from.csv_file
Documentation
Create a database from a csv_file value.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create a database from a csv_file value.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
csv_f csv_… The yes -- no
ile type defa…
of --
the
sour…
valu…
Outputs
field name type description
──────────────────────────────────────
database database The result
value.
create.database.from.csv_file_bundle
Documentation
Create a database from a csv_file_bundle value.
Unless 'merge_into_single_table' is set to 'True', each
csv file will create one table in the resulting
database. If this option is set, only a single table
with all the values of all csv files will be created.
For this to work, all csv files should follow the same
schema.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create a database from a csv_file_bundle
value.
Unless 'merge_into_single_table' is set
to 'True', each csv file will create one
table
in the resulting database. If this
option is set, only a single table with
all the values of all
csv files will be created. For this to
work, all csv files should follow the
same schema.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
csv_f csv_… The yes -- no
ile_b type defa…
undle of --
the
sour…
valu…
Outputs
field name type description
──────────────────────────────────────
database database The result
value.
create.database.from.table
Documentation
Create a database value from a table.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create a database value from a table.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
table table The yes -- no
type defa…
of --
the
sour…
valu…
table stri… The no impo…
_name name
of
the
table
in
the
new
data…
Outputs
field name type description
──────────────────────────────────────
database database The result
value.
create.table.from.csv_file
Documentation
Create a table from a csv_file value.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create a table from a csv_file value.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
csv_f csv_… The yes -- no
ile type defa…
of --
the
sour…
valu…
Outputs
field name type description
──────────────────────────────────────
table table The result
value.
create.table.from.text_file_bundle
Documentation
Create a table value from a text file_bundle.
The resulting table will have (at a minimum) the
following collumns:
• id: an auto-assigned index
• rel_path: the relative path of the file (from the
provided base path)
• content: the text file content
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create a table value from a text
file_bundle.
The resulting table will have (at a
minimum) the following collumns:
- id: an auto-assigned index
- rel_path: the relative path of the
file (from the provided base path)
- content: the text file content
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
text_ text… The yes -- no
file_ type defa…
bundl of --
e the
sour…
valu…
Outputs
field name type description
──────────────────────────────────────
table table The result
value.
deserialize.array.as.python_object
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
array array The yes --
value no
obje… def…
--
deser any Seri… no --
ializ spec… no
ation conf… def…
_conf --
ig
Outputs
field name type descripti…
──────────────────────────────────────
python_obj python_ob… The
ect deseriali…
python
object
instance.
deserialize.database.as.python_object
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
datab data… The yes -- no
ase value defa…
obje… --
deser any Seri… no -- no
ializ spec… defa…
ation conf… --
_conf
ig
Outputs
field name type descripti…
──────────────────────────────────────
python_obj python_ob… The
ect deseriali…
python
object
instance.
deserialize.table.as.python_object
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
table table The yes --
value no
obje… def…
--
deser any Seri… no --
ializ spec… no
ation conf… def…
_conf --
ig
Outputs
field name type descripti…
──────────────────────────────────────
python_obj python_ob… The
ect deseriali…
python
object
instance.
export.table.as.csv_file
Documentation
Export a table as csv file.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Export a table as csv file.
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
table table A yes --
value no
of def…
type --
'tab…
base_ stri… The no --
path dire… no
to def…
expo… --
the
file…
to.
name stri… The no --
(bas… no
name def…
of --
the
expo…
file…
expor bool… Whet… no Fal…
t_met to
adata also
expo…
the
value
meta…
Outputs
field name type description
──────────────────────────────────────
export_detail dict Details about
s the exported
files/folder…
Documentation
Extract a date array from a table column.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo:
https://github.com/DHARPA-Project/kiara
documentation:
https://dharpa.org/kiara_documentation/
Operation details
Documentation Extract a date array from a table
column.
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
table table A yes --
tabl… no
def…
--
colum stri… The yes --
n_nam name no
e of def…
the --
colu…
to
extr…
parse bool… If no True
_date set
_arra to
y__fo 'Tru…
rce_n raise
on_nu an
ll error
if
any
of
the
stri…
in
the
array
can't
be
pars…
parse inte… The no --
_date mini… no
_arra index def…
y__mi from --
n_ind where
ex to
start
pars…
the
stri…
parse inte… The no --
_date maxi… no
_arra index def…
y__ma until --
x_ind whic
ex to
parse
the
stri…
parse list A no []
_date list
_arra of
y__re toke…
move_ to
token repl…
s with
a
sing…
whit…
befo…
pars…
the
inpu…
Outputs
field name type description
──────────────────────────────────────
date_array array The resulting
array with
items of a date
data type.
import.database.from.csv_file
Documentation
Import a database from a csv file.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo:
https://github.com/DHARPA-Project/kiara
documentation:
https://dharpa.org/kiara_documentation/
Operation details
Documentation Import a database from a csv file.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
path stri… The yes -- no
local defa…
path --
to
the
file.
Outputs
field name type description
──────────────────────────────────────
imported_fi file The loaded
le files.
database database The result
value.
import.table.from.csv_file
Documentation
Import a table from a csv file.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo:
https://github.com/DHARPA-Project/kiara
documentation:
https://dharpa.org/kiara_documentation/
Operation details
Documentation Import a table from a csv file.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
path stri… The yes -- no
local defa…
path --
to
the
file.
Outputs
field name type description
──────────────────────────────────────
imported_file file The loaded
files.
table table The result
value.
import.table.from.text_file_bundle
Documentation
Load a table from a bundle of text files.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Labels package: kiara
References source_repo:
https://github.com/DHARPA-Project/kiara
documentation:
https://dharpa.org/kiara_documentation/
Operation details
Documentation Load a table from a bundle of text
files.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
path stri… The yes -- no
local defa…
path --
of
the
fold…
to
impo…
Outputs
field name type descripti…
──────────────────────────────────────
imported_f file_bund… The
ile_bundle imported
file
bundle.
table table The result
value.
parse.date_array
Documentation
Create an array of date objects from an array of
strings.
This module is very simplistic at the moment, more
functionality and options will be added in the future.
At its core, this module uses the standard parser from
the dateutil package to parse strings into dates. As
this parser can't handle complex strings, the input
strings can be pre-processed in the following ways:
• 'cut' non-relevant parts of the string (using
'min_index' & 'max_index' input/config options)
• remove matching tokens from the string, and replace
them with a single whitespace (using the
'remove_tokens' option)
By default, if an input string can't be parsed this
module will raise an exception. This can be prevented by
setting this modules 'force_non_null' config option or
input to 'False', in which case un-parsable strings will
appear as 'NULL' value in the resulting array.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Create an array of date objects from an
array of strings.
This module is very simplistic at the
moment, more functionality and options
will be added in the future.
At its core, this module uses the
standard parser from the
(https://github.com/dateutil/dateutil)
package to parse strings into dates. As
this parser can't handle
complex strings, the input strings can
be pre-processed in the following ways:
- 'cut' non-relevant parts of the string
(using 'min_index' & 'max_index'
input/config options)
- remove matching tokens from the
string, and replace them with a single
whitespace (using the 'remove_tokens'
option)
By default, if an input string can't be
parsed this module will raise an
exception. This can be prevented by
setting this modules 'force_non_null'
config option or input to 'False', in
which case un-parsable strings
will appear as 'NULL' value in the
resulting array.
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
array array The yes --
input no
arra… def…
--
force bool… If no True
_non_ set
null to
'Tru…
raise
an
error
if
any
of
the
stri…
in
the
array
can't
be
pars…
min_i inte… The no --
ndex mini… no
index def…
from --
where
to
start
pars…
the
stri…
max_i inte… The no --
ndex maxi… no
index def…
until --
whic
to
parse
the
stri…
remov list A no []
e_tok list
ens of
toke…
to
repl…
with
a
sing…
whit…
befo…
pars…
the
inpu…
Outputs
field name type description
──────────────────────────────────────
date_array array The resulting
array with
items of a date
data type.
query.database
Documentation
Execute a sql query against a (sqlite) database.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Execute a sql query against a (sqlite)
database.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
datab data… The yes -- no
ase data… defa…
to --
quer…
query stri… The yes -- no
query defa…
to --
exec…
Outputs
field name type description
──────────────────────────────────────
query_result table The query
result.
query.table
Documentation
Execute a sql query against an (Arrow) table.
The default relation name for the sql query is 'data',
but can be modified by the 'relation_name' config
option/input.
If the 'query' module config option is not set, users
can provide their own query, otherwise the pre-set one
will be used.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Execute a sql query against an (Arrow)
table.
The default relation name for the sql
query is 'data', but can be modified by
the 'relation_name' config option/input.
If the 'query' module config option is
not set, users can provide their own
query, otherwise the pre-set
one will be used.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
table table The yes -- no
table defa…
to --
query
query stri… The yes -- no
quer… defa…
--
relat stri… The no data
ion_n name
ame the
table
is
refe…
to in
the
sql
quer…
Outputs
field name type description
──────────────────────────────────────
query_result table The query
result.
render.database.as.string
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
value data… A yes -- no
value defa…
of --
type
'dat…
rende dict Inst… no {}
r_con on
fig how
(or
what)
to
rend…
the
prov…
valu…
Outputs
field name type descripti…
──────────────────────────────────────
render_val render_va… The
ue_result rendered
value,
incl. some
metadata.
render.database.as.terminal_renderable
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
value data… A yes -- no
value defa…
of --
type
'dat…
rende dict Inst… no {}
r_con on
fig how
(or
what)
to
rend…
the
prov…
valu…
Outputs
field name type descripti…
──────────────────────────────────────
render_val render_va… The
ue_result rendered
value,
incl. some
metadata.
render.table.as.string
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
value table A yes --
value no
of def…
type --
'tab…
rende dict Inst… no {}
r_con on
fig how
(or
what)
to
rend…
the
prov…
valu…
Outputs
field name type descripti…
──────────────────────────────────────
render_val render_va… The
ue_result rendered
value,
incl. some
metadata.
render.table.as.terminal_renderable
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
value table A yes --
value no
of def…
type --
'tab…
rende dict Inst… no {}
r_con on
fig how
(or
what)
to
rend…
the
prov…
valu…
Outputs
field name type descripti…
──────────────────────────────────────
render_val render_va… The
ue_result rendered
value,
incl. some
metadata.
table.cut_column
Documentation
Cut off one column from a table, returning an array.
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation Cut off one column from a table,
returning an array.
Inputs
field
name type desc… Req… Defa…
──────────────────────────────────────
table table A yes -- no
tabl… defa…
--
colum stri… The yes -- no
n_nam name defa…
e of --
the
colu…
to
extr…
Outputs
field name type description
──────────────────────────────────────
array array The column.
table_filter.drop_columns
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
value table A yes --
value no
of def…
type --
'tab…
colum list The no --
ns name no
of def…
the --
colu…
to
incl…
ignor bool… Whet… no True
e_inv to
alid_ igno…
colum inva…
n_nam colu…
es name…
Outputs
field name type description
──────────────────────────────────────
value table The filtered
value.
table_filter.select_columns
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
value table A yes --
value no
of def…
type --
'tab…
colum list The no --
ns name no
of def…
the --
colu…
to
incl…
ignor bool… Whet… no True
e_inv to
alid_ igno…
colum inva…
n_nam colu…
es name…
Outputs
field name type description
──────────────────────────────────────
value table The filtered
value.
table_filter.select_rows
Documentation
-- n/a --
Author(s)
Markus Binsteiner markus@frkl.io
Context
Tags tabular
Labels package: kiara_plugin.tabular
References source_repo:
https://github.com/DHARPA-Project/kiara_pl…
documentation:
https://DHARPA-Project.github.io/kiara_plu…
Operation details
Documentation -- n/a --
Inputs
field
name type desc… Requ… Def…
──────────────────────────────────────
value table A yes --
value no
of def…
type --
'tab…
Outputs
field name type description
──────────────────────────────────────
value table The filtered
value.