35 "type":
"FixedLengthWriteDataProvider",
36 "supports_create": True,
43 "path": <DataProviderOptionInfo>{
44 "type": AbstractDataProviderType::get(StringType),
45 "desc":
"the path to the fixed-length data; mutually exclusive with \"stream\"; the output location "
46 "is handled by a call to FileLocationHandler::getOutputStreamForLocation()",
48 "stream": <DataProviderOptionInfo>{
49 "type": AbstractDataProviderType::get(
new Type(
"OutputStream")),
50 "desc":
"an output stream for fixed-length data; mutually exclusive with \"path\"",
52 "spec": <DataProviderOptionInfo>{
53 "type": AbstractDataProviderType::get(AutoHashType),
54 "desc":
"the fixed-length record specification hash",
57 "date_format": <DataProviderOptionInfo>{
58 "type": AbstractDataProviderType::get(StringType),
59 "desc":
"the default global date format for `date` fields",
61 "encoding": <DataProviderOptionInfo>{
62 "type": AbstractDataProviderType::get(StringType),
63 "desc":
"the encoding for strings",
65 "eol": <DataProviderOptionInfo>{
66 "type": AbstractDataProviderType::get(StringType),
67 "desc":
"the end of line characters",
69 "file_flags": <DataProviderOptionInfo>{
70 "type": AbstractDataProviderType::get(SoftIntType),
71 "desc":
"additional writer file open flags; `O_WRONLY | O_CREAT` is used by default; use `O_EXCL` to "
72 "ensure not to overwrite the target or `O_TRUNC` to replace any existing file or `O_APPEND` to "
73 "append to an existing file",
75 "ignore_empty": <DataProviderOptionInfo>{
76 "type": AbstractDataProviderType::get(SoftBoolType),
77 "desc":
"if `true` then empty lines are ignored",
79 "number_format": <DataProviderOptionInfo>{
80 "type": AbstractDataProviderType::get(StringType),
81 "desc":
"the default global number format for `float` or `number` fields",
83 "timezone": <DataProviderOptionInfo>{
84 "type": AbstractDataProviderType::get(StringType),
85 "desc":
"a string giving a time zone region name or an integer offset in seconds east of UTC",
87 "truncate": <DataProviderOptionInfo>{
88 "type": AbstractDataProviderType::get(SoftBoolType),
89 "desc":
"controls whether to truncate an output field value if its bigger than its specified "
90 "`length`; the default is `false`",
92 "tab2space": <DataProviderOptionInfo>{
93 "type": AbstractDataProviderType::get(SoftIntType),
94 "desc":
"Controls whether to replace tabs with spaces and its value determines how many spaces to "
95 "output in place of one tab character",
125 constructor(OutputStream stream, hash<auto> specs, *hash<auto> opts);
Structured abstract writer for fixed-length lines.
Definition: FixedLengthAbstractWriter.qc.dox.h:29
Provides a data provider for reading fixed-length files.
Definition: FixedLengthWriteDataProvider.qc.dox.h:30
const FixedLengthWriteOptionList
write option list
Definition: FixedLengthWriteDataProvider.qc.dox.h:100
constructor(*hash< auto > options)
Creates the object from constructor options.
const ProviderInfo
Provider info.
Definition: FixedLengthWriteDataProvider.qc.dox.h:34
constructor(OutputStream stream, hash< auto > specs, *hash< auto > opts)
Creates the FixedLengthWriteDataProvider with the output data stream where data will be writeen and a...
constructor(string path, hash< auto > specs, *hash< auto > opts)
Creates the FixedLengthWriteDataProvider with the output path and optionally an option hash.
string getName()
Returns the object name.
const ConstructorOptions
Constructor options.
Definition: FixedLengthWriteDataProvider.qc.dox.h:42
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Creates the given record to the data provider.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
FixedLengthAbstractWriter writer
the writer object
Definition: FixedLengthWriteDataProvider.qc.dox.h:104
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition: FixedLengthAbstractIterator.qc.dox.h:27