arrow.csvread_options

Module for [CSVReadOptions] class

class CSVReadOptions CSVReadOptionsGidBuilder CSVReadOptionsGidBuilderImpl

Types 3

classCSVReadOptions : gobject.object.ObjectWrap
Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
CSVReadOptions self() nothrowReturns `this`, for use in `with` statements.
CSVReadOptionsGidBuilder builder() static nothrowGet builder for [arrow.csvread_options.CSVReadOptions] Returns: New builder object
bool allowNewlinesInValues() @property nothrowGet `allowNewlinesInValues` property. Returns: Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters.
void allowNewlinesInValues(bool propval) @property nothrowSet `allowNewlinesInValues` property. Params: propval = Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters.
bool allowNullStrings() @property nothrowGet `allowNullStrings` property. Returns: Whether string / binary columns can have null values. If true, then strings in "null_values" are considered null for string columns. If false, then all str...
void allowNullStrings(bool propval) @property nothrowSet `allowNullStrings` property. Params: propval = Whether string / binary columns can have null values. If true, then strings in "null_values" are considered null for string columns. If false, the...
int blockSize() @property nothrowGet `blockSize` property. Returns: Block size we request from the IO layer; also determines the size of chunks when #GArrowCSVReadOptions:use-threads is true.
void blockSize(int propval) @property nothrowSet `blockSize` property. Params: propval = Block size we request from the IO layer; also determines the size of chunks when #GArrowCSVReadOptions:use-threads is true.
bool checkUtf8() @property nothrowGet `checkUtf8` property. Returns: Whether to check UTF8 validity of string columns.
void checkUtf8(bool propval) @property nothrowSet `checkUtf8` property. Params: propval = Whether to check UTF8 validity of string columns.
char delimiter() @property nothrowGet `delimiter` property. Returns: Field delimiter character.
void delimiter(char propval) @property nothrowSet `delimiter` property. Params: propval = Field delimiter character.
char escapeCharacter() @property nothrowGet `escapeCharacter` property. Returns: Escaping character. This is used only when #GArrowCSVReadOptions:is-escaped is true.
void escapeCharacter(char propval) @property nothrowSet `escapeCharacter` property. Params: propval = Escaping character. This is used only when #GArrowCSVReadOptions:is-escaped is true.
bool generateColumnNames() @property nothrow
void generateColumnNames(bool propval) @property nothrow
bool ignoreEmptyLines() @property nothrowGet `ignoreEmptyLines` property. Returns: Whether empty lines are ignored. If false, an empty line represents a simple empty value (assuming a one-column CSV file).
void ignoreEmptyLines(bool propval) @property nothrowSet `ignoreEmptyLines` property. Params: propval = Whether empty lines are ignored. If false, an empty line represents a simple empty value (assuming a one-column CSV file).
bool isDoubleQuoted() @property nothrowGet `isDoubleQuoted` property. Returns: Whether a quote inside a value is double quoted.
void isDoubleQuoted(bool propval) @property nothrowSet `isDoubleQuoted` property. Params: propval = Whether a quote inside a value is double quoted.
bool isEscaped() @property nothrowGet `isEscaped` property. Returns: Whether escaping is used.
void isEscaped(bool propval) @property nothrowSet `isEscaped` property. Params: propval = Whether escaping is used.
bool isQuoted() @property nothrowGet `isQuoted` property. Returns: Whether quoting is used.
void isQuoted(bool propval) @property nothrowSet `isQuoted` property. Params: propval = Whether quoting is used.
uint nSkipRows() @property nothrowGet `nSkipRows` property. Returns: The number of header rows to skip (not including the row of column names, if any)
void nSkipRows(uint propval) @property nothrowSet `nSkipRows` property. Params: propval = The number of header rows to skip (not including the row of column names, if any)
char quoteCharacter() @property nothrowGet `quoteCharacter` property. Returns: Quoting character. This is used only when #GArrowCSVReadOptions:is-quoted is true.
void quoteCharacter(char propval) @property nothrowSet `quoteCharacter` property. Params: propval = Quoting character. This is used only when #GArrowCSVReadOptions:is-quoted is true.
bool useThreads() @property nothrowGet `useThreads` property. Returns: Whether to use the global CPU thread pool.
void useThreads(bool propval) @property nothrowSet `useThreads` property. Params: propval = Whether to use the global CPU thread pool.
void addColumnName(string columnName) nothrow
void addColumnType(string name, arrow.data_type.DataType dataType) nothrowAdd value type of a column.
void addFalseValue(string falseValue) nothrow
void addNullValue(string nullValue) nothrow
void addSchema(arrow.schema.Schema schema) nothrowAdd value types for columns in the schema.
void addTimestampParser(arrow.timestamp_parser.TimestampParser parser) nothrow
void addTrueValue(string trueValue) nothrow
string[] getColumnNames() nothrow
arrow.data_type.DataType[string] getColumnTypes() nothrow
string[] getFalseValues() nothrow
string[] getNullValues() nothrow
arrow.timestamp_parser.TimestampParser[] getTimestampParsers() nothrow
string[] getTrueValues() nothrow
void setColumnNames(string[] columnNames) nothrow
void setFalseValues(string[] falseValues) nothrow
void setNullValues(string[] nullValues) nothrow
void setTimestampParsers(arrow.timestamp_parser.TimestampParser[] parsers) nothrow
void setTrueValues(string[] trueValues) nothrow
Constructors
this(void * ptr, Flag!"Take" take)
this()
classCSVReadOptionsGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for arrow.csvread_options.CSVReadOptions

Methods
T allowNewlinesInValues(bool propval) nothrowSet `allowNewlinesInValues` property. Params: propval = Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters. Returns: Builder instance for fluent chaining
T allowNullStrings(bool propval) nothrowSet `allowNullStrings` property. Params: propval = Whether string / binary columns can have null values. If true, then strings in "null_values" are considered null for string columns. If false, the...
T blockSize(int propval) nothrowSet `blockSize` property. Params: propval = Block size we request from the IO layer; also determines the size of chunks when #GArrowCSVReadOptions:use-threads is true. Returns: Builder instance for...
T checkUtf8(bool propval) nothrowSet `checkUtf8` property. Params: propval = Whether to check UTF8 validity of string columns. Returns: Builder instance for fluent chaining
T delimiter(char propval) nothrowSet `delimiter` property. Params: propval = Field delimiter character. Returns: Builder instance for fluent chaining
T escapeCharacter(char propval) nothrowSet `escapeCharacter` property. Params: propval = Escaping character. This is used only when #GArrowCSVReadOptions:is-escaped is true. Returns: Builder instance for fluent chaining
T generateColumnNames(bool propval) nothrow
T ignoreEmptyLines(bool propval) nothrowSet `ignoreEmptyLines` property. Params: propval = Whether empty lines are ignored. If false, an empty line represents a simple empty value (assuming a one-column CSV file). Returns: Builder instan...
T isDoubleQuoted(bool propval) nothrowSet `isDoubleQuoted` property. Params: propval = Whether a quote inside a value is double quoted. Returns: Builder instance for fluent chaining
T isEscaped(bool propval) nothrowSet `isEscaped` property. Params: propval = Whether escaping is used. Returns: Builder instance for fluent chaining
T isQuoted(bool propval) nothrowSet `isQuoted` property. Params: propval = Whether quoting is used. Returns: Builder instance for fluent chaining
T nSkipRows(uint propval) nothrowSet `nSkipRows` property. Params: propval = The number of header rows to skip (not including the row of column names, if any) Returns: Builder instance for fluent chaining
T quoteCharacter(char propval) nothrowSet `quoteCharacter` property. Params: propval = Quoting character. This is used only when #GArrowCSVReadOptions:is-quoted is true. Returns: Builder instance for fluent chaining
T useThreads(bool propval) nothrowSet `useThreads` property. Params: propval = Whether to use the global CPU thread pool. Returns: Builder instance for fluent chaining
classCSVReadOptionsGidBuilder : CSVReadOptionsGidBuilderImpl!CSVReadOptionsGidBuilder

Fluent builder for arrow.csvread_options.CSVReadOptions

Methods
CSVReadOptions build() nothrowCreate object from builder. Returns: New object