Tables
var h5tb = require('hdf5').h5tb;
A column of strings is set fixed width to the widest in the set (working on other possible solutions). The return table is equivalent
h5tb.makeTable(id, name, model)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it.
h5tb.readTable(id, name)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- return ← a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it.
h5tb.appendRecords(id, name, model)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it.
h5tb.writeRecords(id, name, start, model)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . This is a sub model where the length of columns and start are less than the whole table
h5tb.readRecords(id, name, start, nrecords)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- nrecords &rarr # of records
- return ← a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . This will be a sub model
h5tb.deleteRecord(id, name, start, nrecords)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- nrecords &rarr # of records
h5tb.insertRecord(id, name, start, model)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . It needs to match the # of columns and the types of the original table.
h5tb.writeFieldsName(id, name, start, model);
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . It needs to less than or equal to the # of columns and the types of the set of columns chosen by name in the original table.
h5tb.writeFieldsIndex(id, name, start, model, array)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . It needs to less than or equal to the # of columns and the types of the set of columns chosen by the array parameter in the original table.
- array → an array of indices choosing the columns by index. (e.g. [0, 5]
h5tb.readFieldsName(id, name, start, nrecords, array)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- nrecords &rarr # of records
- array → an array of column names choosing the columns. (e.g. [“Index”, “Coffee Blends”]
h5tb.readFieldsIndex(id, name, start, nrecords, array)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- nrecords &rarr # of records
- array → an array of indices choosing the columns by index. (e.g. [0, 5]
h5tb.getTableInfo(id, name)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- return ← an info object with two attributes; nfields for the # of columns and nrecords
h5tb.getFieldInfo(id, name)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- return ← an info object with the attribute length for the # of records
h5tb.deleteField(id, name, name)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- name → The field name
h5tb.insertField(id, name, start, model)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The table name
- start &rarr starting record index
- model → a model composed of an Array of typed arrays and Array of strings each representing a column in the table. Each column has a name attribute to name it. . It needs to less than or equal to the # of columns and the types of the set of columns chosen by the array parameter in the original table.
h5tb.addRecordsFrom(id, source name, start1, nrecords, name, start2)
- id → the group or file id location. Every group and the file return with an id attribute
- name → The source table name
- start1 &rarr starting record index
- nrecords &rarr # of records
- name → The destination table name
- start2 &rarr starting record index for second table
h5tb.combineTables(id1, name1, id2, name2, name3)
- id1 → the group or file id location. Every group and the file return with an id attribute
- name1 → The table name
- id2 → the group or file id location. Every group and the file return with an id attribute
- name2 → The table name
- name3 → The destination table name