35 "type":
"FixedLengthReadDataProvider",
36 "supports_read": True,
38 "supports_search_expressions": True,
41 "expressions": AbstractDataProvider::GenericExpressions,
46 "path": <DataProviderOptionInfo>{
47 "type": AbstractDataProviderType::get(StringType),
48 "desc":
"the path to the fixed-length data; mutually exclusive with \"stream\"; resolved with a call "
49 "to FileLocationHandler::getBinaryStreamFromLocation()",
51 "stream": <DataProviderOptionInfo>{
52 "type": AbstractDataProviderType::get(
new Type(
"InputStream")),
53 "desc":
"the input stream for fixed-length data; mutually exclusive with \"path\"",
55 "spec": <DataProviderOptionInfo>{
56 "type": AbstractDataProviderType::get(AutoHashType),
57 "desc":
"the fixed-length record specification hash",
60 "date_format": <DataProviderOptionInfo>{
61 "type": AbstractDataProviderType::get(StringType),
62 "desc":
"the default global date format for `date` fields",
64 "encoding": <DataProviderOptionInfo>{
65 "type": AbstractDataProviderType::get(StringType),
66 "desc":
"the encoding for strings",
68 "eol": <DataProviderOptionInfo>{
69 "type": AbstractDataProviderType::get(StringType),
70 "desc":
"the end of line characters",
72 "ignore_empty": <DataProviderOptionInfo>{
73 "type": AbstractDataProviderType::get(SoftBoolType),
74 "desc":
"if `true` then empty lines are ignored",
76 "number_format": <DataProviderOptionInfo>{
77 "type": AbstractDataProviderType::get(StringType),
78 "desc":
"the default global number format for `float` or `number` fields",
80 "timezone": <DataProviderOptionInfo>{
81 "type": AbstractDataProviderType::get(StringType),
82 "desc":
"a string giving a time zone region name or an integer offset in seconds east of UTC",
112 constructor(StringInputStream stream, hash<auto> spec, *hash<auto> opts);
123 constructor(InputStream stream, *
string encoding, hash<auto> spec, *hash<auto> opts);
139 AbstractDataProviderRecordIterator
searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
148 AbstractDataProviderRecordIterator
searchRecordsImpl(*hash<DataProviderExpression> where_cond, *hash<auto> search_options);
const GenericRecordSearchOptions
Structured line iterator for abstract data allowing efficient "pipelined" processing.
Definition: FixedLengthAbstractIterator.qc.dox.h:29
Provides a data provider for reading fixed-length files.
Definition: FixedLengthReadDataProvider.qc.dox.h:30
const FixedLengthReadOptionList
iteration option list
Definition: FixedLengthReadDataProvider.qc.dox.h:87
constructor(StringInputStream stream, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider with the string input data stream, the record specifications,...
constructor(InputStream stream, *string encoding, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider from a binary input data stream, the record specifications,...
constructor(*hash< auto > options)
Creates the object from constructor options.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
constructor(string path, hash< auto > spec, *hash< auto > opts)
Creates the FixedLengthReadDataProvider with the input data path, the record specifications,...
FixedLengthAbstractIterator i
The iterator object.
Definition: FixedLengthReadDataProvider.qc.dox.h:91
const ConstructorOptions
Constructor options.
Definition: FixedLengthReadDataProvider.qc.dox.h:45
const ProviderInfo
Provider info.
Definition: FixedLengthReadDataProvider.qc.dox.h:34
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
string getName()
Returns the object name.
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition: FixedLengthAbstractIterator.qc.dox.h:27