Qore CsvUtil Module Reference
1.6
|
The CsvFileIterator class allows CSV files to be iterated on a record basis. More...
Public Member Functions | |
constructor (string path, *hash opts) | |
Creates the CsvFileIterator in single-type mode with the path of the file to read and an option hash. More... | |
constructor (string path, hash spec, hash opts) | |
Creates the CsvFileIterator in multi-type mode with the path of the file to read and optionally an option hash. More... | |
string | getEncoding () |
Returns the character encoding for the file. | |
string | getFileName () |
Returns the file path/name used to open the file. | |
hash< Qore::StatInfo > | hstat () |
Returns a StatInfo hash of the underlying file. | |
auto | memberGate (string name) |
calls AbstractCsvIterator::memberGate() | |
list | stat () |
Returns a stat list of the underlying file. | |
![]() | |
constructor (AbstractLineIterator li, *hash opts) | |
creates the AbstractCsvIterator with an option hash in single-type mode More... | |
constructor (AbstractLineIterator li, hash spec, hash opts) | |
creates the AbstractCsvIterator with an option hash in multi-type mode More... | |
*list | getHeaders () |
Returns the current record headers or NOTHING if no headers have been detected or saved yet. More... | |
*list | getHeaders (string type) |
Returns a list of headers for the given record or NOTHING if the record is not recognized. More... | |
string | getQuote () |
Returns the current quote string. More... | |
hash | getRecord (bool extended) |
Returns the current record as a hash. More... | |
hash | getRecord () |
Returns the current record as a hash. More... | |
auto | getRecordList () |
Returns the current record as a list. More... | |
string | getSeparator () |
Returns the current separator string. More... | |
hash | getValue () |
Returns the current record as a hash. More... | |
string | identifyType (list rec) |
Identify a fixed-length line type using identifyTypeImpl(); may be overridden if necessary. More... | |
int | index () |
Returns the row index being iterated, which does not necessarily correspond to the line number when there are header rows and blank lines are skipped. More... | |
int | lineNumber () |
Returns the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element. More... | |
auto | memberGate (string name) |
Returns the given column value for the current row. More... | |
bool | next () |
Moves the current line / record position to the next line / record; returns False if there are no more lines to iterate. More... | |
Private Attributes | |
string | m_file_path |
the path of the file being iterated | |
The CsvFileIterator class allows CSV files to be iterated on a record basis.
The class is deprecated as CsvIterator provides more flexibility.
Creates the CsvFileIterator in single-type mode with the path of the file to read and an option hash.
path | the path to the CSV file to read |
opts | a hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information |
ABSTRACTCSVITERATOR-ERROR | invalid or unknown option; invalid data type for option; "header_names" is True and "header_lines" is 0 or "headers" is also present; unknown field type |
Creates the CsvFileIterator in multi-type mode with the path of the file to read and optionally an option hash.
path | the path to the CSV file to read |
spec | a hash of field and type definition; see Option Field Hash for more information |
opts | a hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information |