Top | ![]() |
![]() |
![]() |
![]() |
gpointer | record-batch-file-reader | Write / Construct Only |
gboolean | allow-newlines-in-values | Read / Write |
gint | block-size | Read / Write |
gboolean | check-utf8 | Read / Write |
gchar | delimiter | Read / Write |
gchar | escape-character | Read / Write |
gboolean | ignore-empty-lines | Read / Write |
gboolean | is-double-quoted | Read / Write |
gboolean | is-escaped | Read / Write |
gboolean | is-quoted | Read / Write |
guint | n-header-rows | Read / Write |
gpointer | pool | Write / Construct Only |
gchar | quote-character | Read / Write |
gboolean | use-threads | Read / Write |
gpointer | csv-table-reader | Write / Construct Only |
gpointer | feather-table-reader | Write / Construct Only |
gpointer | record-batch-reader | Write / Construct Only |
GObject ├── GArrowCSVReadOptions ├── GArrowCSVReader ├── GArrowFeatherFileReader ├── GArrowRecordBatchFileReader ╰── GArrowRecordBatchReader ├── GArrowRecordBatchStreamReader ├── GArrowTableBatchReader ╰── GArrowRecordBatchStreamReader
GArrowRecordBatchReader is a base class for reading record batches in stream format from input.
GArrowRecordBatchStreamReader is a class for reading record batches in stream format from input synchronously.
GArrowRecordBatchFileReader is a class for reading record batches in file format from input.
GArrowFeatherFileReader is a class for reading columns in Feather file format from input.
GArrowCSVReader is a class for reading table in CSV format from input.
GArrowSchema *
garrow_record_batch_reader_get_schema (GArrowRecordBatchReader *reader
);
Since: 0.4.0
GArrowRecordBatch * garrow_record_batch_reader_get_next_record_batch (GArrowRecordBatchReader *reader
,GError **error
);
garrow_record_batch_reader_get_next_record_batch
has been deprecated since version 0.5.0 and should not be used in newly-written code.
Use garrow_record_batch_reader_read_next()
instead.
Since: 0.4.0
GArrowRecordBatch * garrow_record_batch_reader_read_next_record_batch (GArrowRecordBatchReader *reader
,GError **error
);
garrow_record_batch_reader_read_next_record_batch
has been deprecated since version 0.8.0 and should not be used in newly-written code.
Use garrow_record_batch_reader_read_next()
instead.
Since: 0.5.0
GArrowRecordBatch * garrow_record_batch_reader_read_next (GArrowRecordBatchReader *reader
,GError **error
);
Since: 0.8.0
GArrowTableBatchReader *
garrow_table_batch_reader_new (GArrowTable *table
);
Since: 0.8.0
GArrowRecordBatchStreamReader * garrow_record_batch_stream_reader_new (GArrowInputStream *stream
,GError **error
);
Since: 0.4.0
GArrowRecordBatchFileReader * garrow_record_batch_file_reader_new (GArrowSeekableInputStream *file
,GError **error
);
Since: 0.4.0
GArrowSchema *
garrow_record_batch_file_reader_get_schema
(GArrowRecordBatchFileReader *reader
);
Since: 0.4.0
guint
garrow_record_batch_file_reader_get_n_record_batches
(GArrowRecordBatchFileReader *reader
);
Since: 0.4.0
GArrowMetadataVersion
garrow_record_batch_file_reader_get_version
(GArrowRecordBatchFileReader *reader
);
Since: 0.4.0
GArrowRecordBatch * garrow_record_batch_file_reader_get_record_batch (GArrowRecordBatchFileReader *reader
,guint i
,GError **error
);
garrow_record_batch_file_reader_get_record_batch
has been deprecated since version 0.5.0 and should not be used in newly-written code.
Use garrow_record_batch_file_reader_read_record_batch()
instead.
reader |
||
i |
The index of the target record batch. |
|
error |
Return location for a GError or |
[nullable] |
Since: 0.4.0
GArrowRecordBatch * garrow_record_batch_file_reader_read_record_batch (GArrowRecordBatchFileReader *reader
,guint i
,GError **error
);
reader |
||
i |
The index of the target record batch. |
|
error |
Return location for a GError or |
[nullable] |
Since: 0.5.0
GArrowFeatherFileReader * garrow_feather_file_reader_new (GArrowSeekableInputStream *file
,GError **error
);
Since: 0.4.0
gchar *
garrow_feather_file_reader_get_description
(GArrowFeatherFileReader *reader
);
The description of the file if it exists,
NULL
otherwise. You can confirm whether description exists or not by
garrow_feather_file_reader_has_description()
.
It should be freed with g_free()
when no longer needed.
[nullable][transfer full]
Since: 0.4.0
gboolean
garrow_feather_file_reader_has_description
(GArrowFeatherFileReader *reader
);
Since: 0.4.0
gint
garrow_feather_file_reader_get_version
(GArrowFeatherFileReader *reader
);
Since: 0.4.0
gint64
garrow_feather_file_reader_get_n_rows (GArrowFeatherFileReader *reader
);
Since: 0.4.0
gint64
garrow_feather_file_reader_get_n_columns
(GArrowFeatherFileReader *reader
);
Since: 0.4.0
gchar * garrow_feather_file_reader_get_column_name (GArrowFeatherFileReader *reader
,gint i
);
The i-th column name in the file.
It should be freed with g_free()
when no longer needed.
[transfer full]
Since: 0.4.0
GArrowColumn * garrow_feather_file_reader_get_column (GArrowFeatherFileReader *reader
,gint i
,GError **error
);
reader |
||
i |
The index of the target column. |
|
error |
Return location for a GError or |
[nullable] |
Since: 0.4.0
GList * garrow_feather_file_reader_get_columns (GArrowFeatherFileReader *reader
,GError **error
);
Since: 0.4.0
GArrowTable * garrow_feather_file_reader_read (GArrowFeatherFileReader *reader
,GError **error
);
Since: 0.12.0
GArrowTable * garrow_feather_file_reader_read_indices (GArrowFeatherFileReader *reader
,const gint *indices
,guint n_indices
,GError **error
);
reader |
||
indices |
The indices of column to be read. |
[array length=n_indices] |
n_indices |
The number of indices. |
|
error |
Return location for a GError or |
[nullable] |
Since: 0.12.0
GArrowTable * garrow_feather_file_reader_read_names (GArrowFeatherFileReader *reader
,const gchar **names
,guint n_names
,GError **error
);
reader |
||
names |
The names of column to be read. |
[array length=n_names] |
n_names |
The number of names. |
|
error |
Return location for a GError or |
[nullable] |
Since: 0.12.0
GArrowCSVReadOptions *
garrow_csv_read_options_new (void
);
Since: 0.12.0
void garrow_csv_read_options_add_column_type (GArrowCSVReadOptions *options
,const gchar *name
,GArrowDataType *data_type
);
Add value type of a column.
Since: 0.12.0
void garrow_csv_read_options_add_schema (GArrowCSVReadOptions *options
,GArrowSchema *schema
);
Add value types for columns in the schema.
Since: 0.12.0
GHashTable *
garrow_csv_read_options_get_column_types
(GArrowCSVReadOptions *options
);
The column name and value type mapping of the options.
[transfer full][element-type gchar* GArrowDataType]
Since: 0.12.0
GArrowCSVReader * garrow_csv_reader_new (GArrowInputStream *input
,GArrowCSVReadOptions *options
,GError **error
);
input |
The input to be read. |
|
options |
[nullable] | |
error |
Return location for a GError or |
[nullable] |
Since: 0.12.0
GArrowTable * garrow_csv_reader_read (GArrowCSVReader *reader
,GError **error
);
Since: 0.12.0
#define GARROW_TYPE_RECORD_BATCH_READER (garrow_record_batch_reader_get_type())
struct GArrowRecordBatchReaderClass { GObjectClass parent_class; };
#define GARROW_TYPE_TABLE_BATCH_READER (garrow_table_batch_reader_get_type())
struct GArrowTableBatchReaderClass { GArrowRecordBatchReaderClass parent_class; };
struct GArrowRecordBatchStreamReader;
It wraps arrow::ipc::RecordBatchStreamReader
.
struct GArrowRecordBatchFileReader;
It wraps arrow::ipc::RecordBatchFileReader
.
#define GARROW_TYPE_FEATHER_FILE_READER (garrow_feather_file_reader_get_type())
struct GArrowFeatherFileReaderClass { GObjectClass parent_class; };
#define GARROW_TYPE_CSV_READ_OPTIONS (garrow_csv_read_options_get_type())
“record-batch-file-reader”
property “record-batch-file-reader” gpointer
The raw std::shared<arrow::ipc::RecordBatchFileReader> *.
Flags: Write / Construct Only
“allow-newlines-in-values”
property “allow-newlines-in-values” gboolean
Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters.
Flags: Read / Write
Default value: FALSE
Since: 0.12.0
“block-size”
property “block-size” gint
Block size we request from the IO layer; also determines the size
of chunks when “use-threads” is TRUE
.
Flags: Read / Write
Allowed values: >= 0
Default value: 1048576
Since: 0.12.0
“check-utf8”
property “check-utf8” gboolean
Whether to check UTF8 validity of string columns.
Flags: Read / Write
Default value: TRUE
Since: 0.12.0
“delimiter”
property “delimiter” gchar
Field delimiter character.
Flags: Read / Write
Allowed values: >= 0
Default value: 44
Since: 0.12.0
“escape-character”
property “escape-character” gchar
Escaping character. This is used only when
“is-escaped” is TRUE
.
Flags: Read / Write
Allowed values: >= 0
Default value: 92
Since: 0.12.0
“ignore-empty-lines”
property “ignore-empty-lines” gboolean
Whether empty lines are ignored. If FALSE
, an empty line
represents a simple empty value (assuming a one-column CSV file).
Flags: Read / Write
Default value: TRUE
Since: 0.12.0
“is-double-quoted”
property “is-double-quoted” gboolean
Whether a quote inside a value is double quoted.
Flags: Read / Write
Default value: TRUE
Since: 0.12.0
“is-escaped”
property “is-escaped” gboolean
Whether escaping is used.
Flags: Read / Write
Default value: FALSE
Since: 0.12.0
“is-quoted”
property “is-quoted” gboolean
Whether quoting is used.
Flags: Read / Write
Default value: TRUE
Since: 0.12.0
“n-header-rows”
property “n-header-rows” guint
The number of header rows to skip (including the first row containing column names)
Flags: Read / Write
Default value: 1
Since: 0.12.0
“quote-character”
property “quote-character” gchar
Quoting character. This is used only when
“is-quoted” is TRUE
.
Flags: Read / Write
Allowed values: >= 0
Default value: 34
Since: 0.12.0
“use-threads”
property “use-threads” gboolean
Whether to use the global CPU thread pool.
Flags: Read / Write
Default value: TRUE
Since: 0.12.0
“csv-table-reader”
property “csv-table-reader” gpointer
The raw std::shared<arrow::csv::TableReader> *.
Flags: Write / Construct Only
“feather-table-reader”
property “feather-table-reader” gpointer
The raw std::shared<arrow::ipc::feather::TableReader> *.
Flags: Write / Construct Only