| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Reader classes: Apache Arrow GLib Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="Apache Arrow GLib Reference Manual"> |
| <link rel="up" href="reader.html" title="Reader"> |
| <link rel="prev" href="reader.html" title="Reader"> |
| <link rel="next" href="orc-file-reader.html" title="ORC reader"> |
| <meta name="generator" content="GTK-Doc V1.27 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#reader-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#reader-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#reader-classes.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="reader.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="reader.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="orc-file-reader.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="reader-classes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="reader-classes.top_of_page"></a>Reader classes</span></h2> |
| <p>Reader classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="reader-classes.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-reader-get-schema" title="garrow_record_batch_reader_get_schema ()">garrow_record_batch_reader_get_schema</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-reader-get-next-record-batch" title="garrow_record_batch_reader_get_next_record_batch ()">garrow_record_batch_reader_get_next_record_batch</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next-record-batch" title="garrow_record_batch_reader_read_next_record_batch ()">garrow_record_batch_reader_read_next_record_batch</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next" title="garrow_record_batch_reader_read_next ()">garrow_record_batch_reader_read_next</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="returnvalue">GArrowTableBatchReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-table-batch-reader-new" title="garrow_table_batch_reader_new ()">garrow_table_batch_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="returnvalue">GArrowRecordBatchStreamReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-stream-reader-new" title="garrow_record_batch_stream_reader_new ()">garrow_record_batch_stream_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="returnvalue">GArrowRecordBatchFileReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-new" title="garrow_record_batch_file_reader_new ()">garrow_record_batch_file_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-schema" title="garrow_record_batch_file_reader_get_schema ()">garrow_record_batch_file_reader_get_schema</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">guint</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-n-record-batches" title="garrow_record_batch_file_reader_get_n_record_batches ()">garrow_record_batch_file_reader_get_n_record_batches</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-version" title="garrow_record_batch_file_reader_get_version ()">garrow_record_batch_file_reader_get_version</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-get-record-batch" title="garrow_record_batch_file_reader_get_record_batch ()">garrow_record_batch_file_reader_get_record_batch</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-read-record-batch" title="garrow_record_batch_file_reader_read_record_batch ()">garrow_record_batch_file_reader_read_record_batch</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="returnvalue">GArrowFeatherFileReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-feather-file-reader-new" title="garrow_feather_file_reader_new ()">garrow_feather_file_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gint</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-feather-file-reader-get-version" title="garrow_feather_file_reader_get_version ()">garrow_feather_file_reader_get_version</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-feather-file-reader-read" title="garrow_feather_file_reader_read ()">garrow_feather_file_reader_read</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-feather-file-reader-read-indices" title="garrow_feather_file_reader_read_indices ()">garrow_feather_file_reader_read_indices</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-feather-file-reader-read-names" title="garrow_feather_file_reader_read_names ()">garrow_feather_file_reader_read_names</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="returnvalue">GArrowCSVReadOptions</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-new" title="garrow_csv_read_options_new ()">garrow_csv_read_options_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-column-type" title="garrow_csv_read_options_add_column_type ()">garrow_csv_read_options_add_column_type</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-schema" title="garrow_csv_read_options_add_schema ()">garrow_csv_read_options_add_schema</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">GHashTable</span> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-get-column-types" title="garrow_csv_read_options_get_column_types ()">garrow_csv_read_options_get_column_types</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-set-null-values" title="garrow_csv_read_options_set_null_values ()">garrow_csv_read_options_set_null_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> ** |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-get-null-values" title="garrow_csv_read_options_get_null_values ()">garrow_csv_read_options_get_null_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-null-value" title="garrow_csv_read_options_add_null_value ()">garrow_csv_read_options_add_null_value</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-set-true-values" title="garrow_csv_read_options_set_true_values ()">garrow_csv_read_options_set_true_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> ** |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-get-true-values" title="garrow_csv_read_options_get_true_values ()">garrow_csv_read_options_get_true_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-true-value" title="garrow_csv_read_options_add_true_value ()">garrow_csv_read_options_add_true_value</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-set-false-values" title="garrow_csv_read_options_set_false_values ()">garrow_csv_read_options_set_false_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> ** |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-get-false-values" title="garrow_csv_read_options_get_false_values ()">garrow_csv_read_options_get_false_values</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-false-value" title="garrow_csv_read_options_add_false_value ()">garrow_csv_read_options_add_false_value</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-set-column-names" title="garrow_csv_read_options_set_column_names ()">garrow_csv_read_options_set_column_names</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gchar</span> ** |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-get-column-names" title="garrow_csv_read_options_get_column_names ()">garrow_csv_read_options_get_column_names</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-read-options-add-column-name" title="garrow_csv_read_options_add_column_name ()">garrow_csv_read_options_add_column_name</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowCSVReader"><span class="returnvalue">GArrowCSVReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-reader-new" title="garrow_csv_reader_new ()">garrow_csv_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-csv-reader-read" title="garrow_csv_reader_read ()">garrow_csv_reader_read</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowJSONReadOptions"><span class="returnvalue">GArrowJSONReadOptions</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-json-read-options-new" title="garrow_json_read_options_new ()">garrow_json_read_options_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="reader-classes.html#GArrowJSONReader"><span class="returnvalue">GArrowJSONReader</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-json-reader-new" title="garrow_json_reader_new ()">garrow_json_reader_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="reader-classes.html#garrow-json-reader-read" title="garrow_json_reader_read ()">garrow_json_reader_read</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader--record-batch-file-reader" title="The “record-batch-file-reader” property">record-batch-file-reader</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--allow-newlines-in-values" title="The “allow-newlines-in-values” property">allow-newlines-in-values</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--allow-null-strings" title="The “allow-null-strings” property">allow-null-strings</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--block-size" title="The “block-size” property">block-size</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--check-utf8" title="The “check-utf8” property">check-utf8</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gchar</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--delimiter" title="The “delimiter” property">delimiter</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gchar</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--escape-character" title="The “escape-character” property">escape-character</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--generate-column-names" title="The “generate-column-names” property">generate-column-names</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--ignore-empty-lines" title="The “ignore-empty-lines” property">ignore-empty-lines</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--is-double-quoted" title="The “is-double-quoted” property">is-double-quoted</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--is-escaped" title="The “is-escaped” property">is-escaped</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--is-quoted" title="The “is-quoted” property">is-quoted</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">guint</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--n-skip-rows" title="The “n-skip-rows” property">n-skip-rows</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gchar</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--quote-character" title="The “quote-character” property">quote-character</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions--use-threads" title="The “use-threads” property">use-threads</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowCSVReader--csv-table-reader" title="The “csv-table-reader” property">csv-table-reader</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowFeatherFileReader--feather-reader" title="The “feather-reader” property">feather-reader</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions--allow-newlines-in-values" title="The “allow-newlines-in-values” property">allow-newlines-in-values</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gint</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions--block-size" title="The “block-size” property">block-size</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"> |
| <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *</td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions--schema" title="The “schema” property">schema</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a class="link" href="reader-classes.html#GArrowJSONReadUnexpectedFieldBehavior" title="enum GArrowJSONReadUnexpectedFieldBehavior"><span class="type">GArrowJSONReadUnexpectedFieldBehavior</span></a></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions--unexpected-field-behavior" title="The “unexpected-field-behavior” property">unexpected-field-behavior</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gboolean</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions--use-threads" title="The “use-threads” property">use-threads</a></td> |
| <td class="property_flags">Read / Write</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowJSONReader--json-table-reader" title="The “json-table-reader” property">json-table-reader</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReader--record-batch-reader" title="The “record-batch-reader” property">record-batch-reader</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <a name="GArrowRecordBatchStreamReader"></a><a name="GArrowRecordBatchFileReader"></a><a name="GArrowCSVReadOptions"></a><a name="GArrowCSVReader"></a><a name="GArrowFeatherFileReader"></a><a name="GArrowJSONReadOptions"></a><a name="GArrowJSONReader"></a><a name="GArrowRecordBatchReader"></a><a name="GArrowTableBatchReader"></a><div class="refsect1"> |
| <a name="reader-classes.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-RECORD-BATCH-READER:CAPS" title="GARROW_TYPE_RECORD_BATCH_READER">GARROW_TYPE_RECORD_BATCH_READER</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReaderClass" title="struct GArrowRecordBatchReaderClass">GArrowRecordBatchReaderClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-TABLE-BATCH-READER:CAPS" title="GARROW_TYPE_TABLE_BATCH_READER">GARROW_TYPE_TABLE_BATCH_READER</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowTableBatchReaderClass" title="struct GArrowTableBatchReaderClass">GArrowTableBatchReaderClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader-struct" title="struct GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader-struct" title="struct GArrowRecordBatchFileReader">GArrowRecordBatchFileReader</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-FEATHER-FILE-READER:CAPS" title="GARROW_TYPE_FEATHER_FILE_READER">GARROW_TYPE_FEATHER_FILE_READER</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowFeatherFileReaderClass" title="struct GArrowFeatherFileReaderClass">GArrowFeatherFileReaderClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-CSV-READ-OPTIONS:CAPS" title="GARROW_TYPE_CSV_READ_OPTIONS">GARROW_TYPE_CSV_READ_OPTIONS</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptionsClass" title="struct GArrowCSVReadOptionsClass">GArrowCSVReadOptionsClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-CSV-READER:CAPS" title="GARROW_TYPE_CSV_READER">GARROW_TYPE_CSV_READER</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowCSVReaderClass" title="struct GArrowCSVReaderClass">GArrowCSVReaderClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">enum</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowJSONReadUnexpectedFieldBehavior" title="enum GArrowJSONReadUnexpectedFieldBehavior">GArrowJSONReadUnexpectedFieldBehavior</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-JSON-READ-OPTIONS:CAPS" title="GARROW_TYPE_JSON_READ_OPTIONS">GARROW_TYPE_JSON_READ_OPTIONS</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptionsClass" title="struct GArrowJSONReadOptionsClass">GArrowJSONReadOptionsClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GARROW-TYPE-JSON-READER:CAPS" title="GARROW_TYPE_JSON_READER">GARROW_TYPE_JSON_READER</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowJSONReaderClass" title="struct GArrowJSONReaderClass">GArrowJSONReaderClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowCSVReadOptions-struct" title="GArrowCSVReadOptions">GArrowCSVReadOptions</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowCSVReader-struct" title="GArrowCSVReader">GArrowCSVReader</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowFeatherFileReader-struct" title="GArrowFeatherFileReader">GArrowFeatherFileReader</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowJSONReadOptions-struct" title="GArrowJSONReadOptions">GArrowJSONReadOptions</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowJSONReader-struct" title="GArrowJSONReader">GArrowJSONReader</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowRecordBatchReader-struct" title="GArrowRecordBatchReader">GArrowRecordBatchReader</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="reader-classes.html#GArrowTableBatchReader-struct" title="GArrowTableBatchReader">GArrowTableBatchReader</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> |
| <span class="lineart">╰──</span> GArrowJSONReadUnexpectedFieldBehavior |
| GObject |
| <span class="lineart">├──</span> GArrowCSVReadOptions |
| <span class="lineart">├──</span> GArrowCSVReader |
| <span class="lineart">├──</span> GArrowFeatherFileReader |
| <span class="lineart">├──</span> GArrowJSONReadOptions |
| <span class="lineart">├──</span> GArrowJSONReader |
| <span class="lineart">├──</span> GArrowRecordBatchFileReader |
| <span class="lineart">╰──</span> GArrowRecordBatchReader |
| <span class="lineart">├──</span> <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader">GArrowRecordBatchStreamReader</a> |
| <span class="lineart">├──</span> GArrowTableBatchReader |
| <span class="lineart">╰──</span> GArrowRecordBatchStreamReader |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.description"></a><h2>Description</h2> |
| <p><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> is a base class for reading record batches |
| in stream format from input.</p> |
| <p><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="type">GArrowRecordBatchStreamReader</span></a> is a class for reading record |
| batches in stream format from input synchronously.</p> |
| <p><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> is a class for reading record |
| batches in file format from input.</p> |
| <p><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> is a class for reading columns in Feather |
| file format from input.</p> |
| <p><a class="link" href="reader-classes.html#GArrowCSVReader"><span class="type">GArrowCSVReader</span></a> is a class for reading table in CSV format from |
| input.</p> |
| <p><a class="link" href="reader-classes.html#GArrowJSONReader"><span class="type">GArrowJSONReader</span></a> is a class for reading table in JSON format from |
| input.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-reader-get-schema"></a><h3>garrow_record_batch_reader_get_schema ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| garrow_record_batch_reader_get_schema (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-get-schema.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-get-schema.returns"></a><h4>Returns</h4> |
| <p>The schema in the stream. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-reader-get-next-record-batch"></a><h3>garrow_record_batch_reader_get_next_record_batch ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_reader_get_next_record_batch |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="warning"> |
| <p><code class="literal">garrow_record_batch_reader_get_next_record_batch</code> has been deprecated since version 0.5.0 and should not be used in newly-written code.</p> |
| <p>Use <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next" title="garrow_record_batch_reader_read_next ()"><code class="function">garrow_record_batch_reader_read_next()</code></a> instead.</p> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-get-next-record-batch.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-get-next-record-batch.returns"></a><h4>Returns</h4> |
| <p>The next record batch in the stream or <code class="literal">NULL</code> on end of stream. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-reader-read-next-record-batch"></a><h3>garrow_record_batch_reader_read_next_record_batch ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_reader_read_next_record_batch |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="warning"> |
| <p><code class="literal">garrow_record_batch_reader_read_next_record_batch</code> has been deprecated since version 0.8.0 and should not be used in newly-written code.</p> |
| <p>Use <a class="link" href="reader-classes.html#garrow-record-batch-reader-read-next" title="garrow_record_batch_reader_read_next ()"><code class="function">garrow_record_batch_reader_read_next()</code></a> instead.</p> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-read-next-record-batch.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-read-next-record-batch.returns"></a><h4>Returns</h4> |
| <p>The next record batch in the stream or <code class="literal">NULL</code> on end of stream. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-5-0.html#api-index-0.5.0">0.5.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-reader-read-next"></a><h3>garrow_record_batch_reader_read_next ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_reader_read_next (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-read-next.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchReader"><span class="type">GArrowRecordBatchReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-reader-read-next.returns"></a><h4>Returns</h4> |
| <p>The next record batch in the stream or <code class="literal">NULL</code> on end of stream. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-table-batch-reader-new"></a><h3>garrow_table_batch_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="returnvalue">GArrowTableBatchReader</span></a> * |
| garrow_table_batch_reader_new (<em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-table-batch-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>table</p></td> |
| <td class="parameter_description"><p>The table to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-table-batch-reader-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="reader-classes.html#GArrowTableBatchReader"><span class="type">GArrowTableBatchReader</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-stream-reader-new"></a><h3>garrow_record_batch_stream_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="returnvalue">GArrowRecordBatchStreamReader</span></a> * |
| garrow_record_batch_stream_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="type">GArrowInputStream</span></a> *stream</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-stream-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>stream</p></td> |
| <td class="parameter_description"><p>The stream to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-stream-reader-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="reader-classes.html#GArrowRecordBatchStreamReader"><span class="type">GArrowRecordBatchStreamReader</span></a> |
| or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-new"></a><h3>garrow_record_batch_file_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="returnvalue">GArrowRecordBatchFileReader</span></a> * |
| garrow_record_batch_file_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *file</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>file</p></td> |
| <td class="parameter_description"><p>The file to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> |
| or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-get-schema"></a><h3>garrow_record_batch_file_reader_get_schema ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| garrow_record_batch_file_reader_get_schema |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-schema.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-schema.returns"></a><h4>Returns</h4> |
| <p>The schema in the file. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-get-n-record-batches"></a><h3>garrow_record_batch_file_reader_get_n_record_batches ()</h3> |
| <pre class="programlisting"><span class="returnvalue">guint</span> |
| garrow_record_batch_file_reader_get_n_record_batches |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-n-record-batches.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-n-record-batches.returns"></a><h4>Returns</h4> |
| <p> The number of record batches in the file.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-get-version"></a><h3>garrow_record_batch_file_reader_get_version ()</h3> |
| <pre class="programlisting"><a class="link" href="arrow-glib-GArrowMetadataVersion.html#GArrowMetadataVersion" title="enum GArrowMetadataVersion"><span class="returnvalue">GArrowMetadataVersion</span></a> |
| garrow_record_batch_file_reader_get_version |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-version.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-version.returns"></a><h4>Returns</h4> |
| <p> The format version in the file.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-get-record-batch"></a><h3>garrow_record_batch_file_reader_get_record_batch ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_file_reader_get_record_batch |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">guint</span> i</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="warning"> |
| <p><code class="literal">garrow_record_batch_file_reader_get_record_batch</code> has been deprecated since version 0.5.0 and should not be used in newly-written code.</p> |
| <p>Use <a class="link" href="reader-classes.html#garrow-record-batch-file-reader-read-record-batch" title="garrow_record_batch_file_reader_read_record_batch ()"><code class="function">garrow_record_batch_file_reader_read_record_batch()</code></a> instead.</p> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-record-batch.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the target record batch.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-get-record-batch.returns"></a><h4>Returns</h4> |
| <p>The i-th record batch in the file or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-reader-read-record-batch"></a><h3>garrow_record_batch_file_reader_read_record_batch ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_file_reader_read_record_batch |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">guint</span> i</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-read-record-batch.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowRecordBatchFileReader"><span class="type">GArrowRecordBatchFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the target record batch.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-reader-read-record-batch.returns"></a><h4>Returns</h4> |
| <p>The i-th record batch in the file or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-5-0.html#api-index-0.5.0">0.5.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-feather-file-reader-new"></a><h3>garrow_feather_file_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="returnvalue">GArrowFeatherFileReader</span></a> * |
| garrow_feather_file_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowSeekableInputStream"><span class="type">GArrowSeekableInputStream</span></a> *file</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>file</p></td> |
| <td class="parameter_description"><p>The file to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> |
| or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-feather-file-reader-get-version"></a><h3>garrow_feather_file_reader_get_version ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gint</span> |
| garrow_feather_file_reader_get_version |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-get-version.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-get-version.returns"></a><h4>Returns</h4> |
| <p> The format version of the file.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-feather-file-reader-read"></a><h3>garrow_feather_file_reader_read ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| garrow_feather_file_reader_read (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read.returns"></a><h4>Returns</h4> |
| <p>The table in the file that has all columns. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-feather-file-reader-read-indices"></a><h3>garrow_feather_file_reader_read_indices ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| garrow_feather_file_reader_read_indices |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, |
| <em class="parameter"><code>const <span class="type">gint</span> *indices</code></em>, |
| <em class="parameter"><code><span class="type">guint</span> n_indices</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read-indices.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>indices</p></td> |
| <td class="parameter_description"><p>The indices of column to be read. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_indices]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_indices</p></td> |
| <td class="parameter_description"><p>The number of indices.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read-indices.returns"></a><h4>Returns</h4> |
| <p>The table in the file that has only the |
| specified columns. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-feather-file-reader-read-names"></a><h3>garrow_feather_file_reader_read_names ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| garrow_feather_file_reader_read_names (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a> *reader</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **names</code></em>, |
| <em class="parameter"><code><span class="type">guint</span> n_names</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read-names.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowFeatherFileReader"><span class="type">GArrowFeatherFileReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>names</p></td> |
| <td class="parameter_description"><p>The names of column to be read. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_names]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_names</p></td> |
| <td class="parameter_description"><p>The number of names.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-feather-file-reader-read-names.returns"></a><h4>Returns</h4> |
| <p>The table in the file that has only the |
| specified columns. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-new"></a><h3>garrow_csv_read_options_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="returnvalue">GArrowCSVReadOptions</span></a> * |
| garrow_csv_read_options_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-column-type"></a><h3>garrow_csv_read_options_add_column_type ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_column_type |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, |
| <em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>);</pre> |
| <p>Add value type of a column.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-add-column-type.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>name</p></td> |
| <td class="parameter_description"><p>The name of the target column.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>data_type</p></td> |
| <td class="parameter_description"><p>The <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> for the column.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-schema"></a><h3>garrow_csv_read_options_add_schema ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_schema (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre> |
| <p>Add value types for columns in the schema.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-add-schema.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>schema</p></td> |
| <td class="parameter_description"><p>The <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that specifies columns and their types.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-get-column-types"></a><h3>garrow_csv_read_options_get_column_types ()</h3> |
| <pre class="programlisting"><span class="returnvalue">GHashTable</span> * |
| garrow_csv_read_options_get_column_types |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-column-types.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-column-types.returns"></a><h4>Returns</h4> |
| <p>The column name and value type mapping of the options. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* GArrowDataType]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-set-null-values"></a><h3>garrow_csv_read_options_set_null_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_set_null_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **null_values</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_null_values</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-set-null-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>null_values</p></td> |
| <td class="parameter_description"><p>The values to be processed as null. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_null_values]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_null_values</p></td> |
| <td class="parameter_description"><p>The number of the specified null values.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-get-null-values"></a><h3>garrow_csv_read_options_get_null_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> ** |
| garrow_csv_read_options_get_null_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>);</pre> |
| <p>Return: (nullable) (array zero-terminated=1) (element-type utf8) (transfer full): |
| The values to be processed as null. It's a <code class="literal">NULL</code>-terminated string array. |
| If the number of values is zero, this returns <code class="literal">NULL</code>. |
| It must be freed with <code class="function">g_strfreev()</code> when no longer needed.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-null-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-null-value"></a><h3>garrow_csv_read_options_add_null_value ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_null_value |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *null_value</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-add-null-value.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>null_value</p></td> |
| <td class="parameter_description"><p>The value to be processed as null.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-set-true-values"></a><h3>garrow_csv_read_options_set_true_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_set_true_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **true_values</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_true_values</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-set-true-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>true_values</p></td> |
| <td class="parameter_description"><p>The values to be processed as true. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_true_values]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_true_values</p></td> |
| <td class="parameter_description"><p>The number of the specified true values.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-get-true-values"></a><h3>garrow_csv_read_options_get_true_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> ** |
| garrow_csv_read_options_get_true_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>);</pre> |
| <p>Return: (nullable) (array zero-terminated=1) (element-type utf8) (transfer full): |
| The values to be processed as true. It's a <code class="literal">NULL</code>-terminated string array. |
| If the number of values is zero, this returns <code class="literal">NULL</code>. |
| It must be freed with <code class="function">g_strfreev()</code> when no longer needed.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-true-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-true-value"></a><h3>garrow_csv_read_options_add_true_value ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_true_value |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *true_value</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-add-true-value.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>true_value</p></td> |
| <td class="parameter_description"><p>The value to be processed as true.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-set-false-values"></a><h3>garrow_csv_read_options_set_false_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_set_false_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **false_values</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_false_values</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-set-false-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>false_values</p></td> |
| <td class="parameter_description"><p>The values to be processed as false. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_false_values]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_false_values</p></td> |
| <td class="parameter_description"><p>The number of the specified false values.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-get-false-values"></a><h3>garrow_csv_read_options_get_false_values ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> ** |
| garrow_csv_read_options_get_false_values |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>);</pre> |
| <p>Return: (nullable) (array zero-terminated=1) (element-type utf8) (transfer full): |
| The values to be processed as false. It's a <code class="literal">NULL</code>-terminated string array. |
| If the number of values is zero, this returns <code class="literal">NULL</code>. |
| It must be freed with <code class="function">g_strfreev()</code> when no longer needed.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-false-values.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-false-value"></a><h3>garrow_csv_read_options_add_false_value ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_false_value |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *false_value</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-add-false-value.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>false_value</p></td> |
| <td class="parameter_description"><p>The value to be processed as false.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-set-column-names"></a><h3>garrow_csv_read_options_set_column_names ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_set_column_names |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> **column_names</code></em>, |
| <em class="parameter"><code><span class="type">gsize</span> n_column_names</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-set-column-names.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>column_names</p></td> |
| <td class="parameter_description"><p>The column names (if empty, will be read from first |
| row after <code class="literal">skip_rows</code>). </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_column_names]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_column_names</p></td> |
| <td class="parameter_description"><p>The number of the specified column names.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-15-0.html#api-index-0.15.0">0.15.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-get-column-names"></a><h3>garrow_csv_read_options_get_column_names ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> ** |
| garrow_csv_read_options_get_column_names |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>);</pre> |
| <p>Return: (nullable) (array zero-terminated=1) (element-type utf8) (transfer full): |
| The column names. It's a <code class="literal">NULL</code>-terminated string array. |
| If the number of values is zero, this returns <code class="literal">NULL</code>. |
| It must be freed with <code class="function">g_strfreev()</code> when no longer needed.</p> |
| <div class="refsect3"> |
| <a name="garrow-csv-read-options-get-column-names.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-15-0.html#api-index-0.15.0">0.15.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-read-options-add-column-name"></a><h3>garrow_csv_read_options_add_column_name ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| garrow_csv_read_options_add_column_name |
| (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code>const <span class="type">gchar</span> *column_name</code></em>);</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-reader-new"></a><h3>garrow_csv_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowCSVReader"><span class="returnvalue">GArrowCSVReader</span></a> * |
| garrow_csv_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="type">GArrowInputStream</span></a> *input</code></em>, |
| <em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>input</p></td> |
| <td class="parameter_description"><p>The input to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReadOptions"><span class="type">GArrowCSVReadOptions</span></a>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-csv-reader-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="reader-classes.html#GArrowCSVReader"><span class="type">GArrowCSVReader</span></a> or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-csv-reader-read"></a><h3>garrow_csv_reader_read ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| garrow_csv_reader_read (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowCSVReader"><span class="type">GArrowCSVReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-csv-reader-read.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowCSVReader"><span class="type">GArrowCSVReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-csv-reader-read.returns"></a><h4>Returns</h4> |
| <p>A read <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-json-read-options-new"></a><h3>garrow_json_read_options_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowJSONReadOptions"><span class="returnvalue">GArrowJSONReadOptions</span></a> * |
| garrow_json_read_options_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-json-read-options-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="reader-classes.html#GArrowJSONReadOptions"><span class="type">GArrowJSONReadOptions</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-json-reader-new"></a><h3>garrow_json_reader_new ()</h3> |
| <pre class="programlisting"><a class="link" href="reader-classes.html#GArrowJSONReader"><span class="returnvalue">GArrowJSONReader</span></a> * |
| garrow_json_reader_new (<em class="parameter"><code><a class="link" href="input-stream-classes.html#GArrowInputStream"><span class="type">GArrowInputStream</span></a> *input</code></em>, |
| <em class="parameter"><code><a class="link" href="reader-classes.html#GArrowJSONReadOptions"><span class="type">GArrowJSONReadOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-json-reader-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>input</p></td> |
| <td class="parameter_description"><p>The input to be read.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowJSONReadOptions"><span class="type">GArrowJSONReadOptions</span></a>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-json-reader-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="reader-classes.html#GArrowJSONReader"><span class="type">GArrowJSONReader</span></a> or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-json-reader-read"></a><h3>garrow_json_reader_read ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="returnvalue">GArrowTable</span></a> * |
| garrow_json_reader_read (<em class="parameter"><code><a class="link" href="reader-classes.html#GArrowJSONReader"><span class="type">GArrowJSONReader</span></a> *reader</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-json-reader-read.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>reader</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="reader-classes.html#GArrowJSONReader"><span class="type">GArrowJSONReader</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-json-reader-read.returns"></a><h4>Returns</h4> |
| <p>A read <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-RECORD-BATCH-READER:CAPS"></a><h3>GARROW_TYPE_RECORD_BATCH_READER</h3> |
| <pre class="programlisting">#define GARROW_TYPE_RECORD_BATCH_READER (garrow_record_batch_reader_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchReaderClass"></a><h3>struct GArrowRecordBatchReaderClass</h3> |
| <pre class="programlisting">struct GArrowRecordBatchReaderClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-TABLE-BATCH-READER:CAPS"></a><h3>GARROW_TYPE_TABLE_BATCH_READER</h3> |
| <pre class="programlisting">#define GARROW_TYPE_TABLE_BATCH_READER (garrow_table_batch_reader_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowTableBatchReaderClass"></a><h3>struct GArrowTableBatchReaderClass</h3> |
| <pre class="programlisting">struct GArrowTableBatchReaderClass { |
| GArrowRecordBatchReaderClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchStreamReader-struct"></a><h3>struct GArrowRecordBatchStreamReader</h3> |
| <pre class="programlisting">struct GArrowRecordBatchStreamReader;</pre> |
| <p>It wraps <code class="literal">arrow::ipc::RecordBatchStreamReader</code>.</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchFileReader-struct"></a><h3>struct GArrowRecordBatchFileReader</h3> |
| <pre class="programlisting">struct GArrowRecordBatchFileReader;</pre> |
| <p>It wraps <code class="literal">arrow::ipc::RecordBatchFileReader</code>.</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-FEATHER-FILE-READER:CAPS"></a><h3>GARROW_TYPE_FEATHER_FILE_READER</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FEATHER_FILE_READER (garrow_feather_file_reader_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFeatherFileReaderClass"></a><h3>struct GArrowFeatherFileReaderClass</h3> |
| <pre class="programlisting">struct GArrowFeatherFileReaderClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-CSV-READ-OPTIONS:CAPS"></a><h3>GARROW_TYPE_CSV_READ_OPTIONS</h3> |
| <pre class="programlisting">#define GARROW_TYPE_CSV_READ_OPTIONS (garrow_csv_read_options_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptionsClass"></a><h3>struct GArrowCSVReadOptionsClass</h3> |
| <pre class="programlisting">struct GArrowCSVReadOptionsClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-CSV-READER:CAPS"></a><h3>GARROW_TYPE_CSV_READER</h3> |
| <pre class="programlisting">#define GARROW_TYPE_CSV_READER (garrow_csv_reader_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReaderClass"></a><h3>struct GArrowCSVReaderClass</h3> |
| <pre class="programlisting">struct GArrowCSVReaderClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadUnexpectedFieldBehavior"></a><h3>enum GArrowJSONReadUnexpectedFieldBehavior</h3> |
| <p>They are corresponding to <code class="literal">arrow::json::UnexpectedFieldBehavior</code> values.</p> |
| <div class="refsect3"> |
| <a name="GArrowJSONReadUnexpectedFieldBehavior.members"></a><h4>Members</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="300px" class="enum_members_name"> |
| <col class="enum_members_description"> |
| <col width="200px" class="enum_members_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-JSON-READ-IGNORE:CAPS"></a>GARROW_JSON_READ_IGNORE</p></td> |
| <td class="enum_member_description"> |
| <p>Ignore other fields.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-JSON-READ-ERROR:CAPS"></a>GARROW_JSON_READ_ERROR</p></td> |
| <td class="enum_member_description"> |
| <p>Return error.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="GARROW-JSON-READ-INFER-TYPE:CAPS"></a>GARROW_JSON_READ_INFER_TYPE</p></td> |
| <td class="enum_member_description"> |
| <p>Infer a type.</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-JSON-READ-OPTIONS:CAPS"></a><h3>GARROW_TYPE_JSON_READ_OPTIONS</h3> |
| <pre class="programlisting">#define GARROW_TYPE_JSON_READ_OPTIONS (garrow_json_read_options_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptionsClass"></a><h3>struct GArrowJSONReadOptionsClass</h3> |
| <pre class="programlisting">struct GArrowJSONReadOptionsClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-JSON-READER:CAPS"></a><h3>GARROW_TYPE_JSON_READER</h3> |
| <pre class="programlisting">#define GARROW_TYPE_JSON_READER (garrow_json_reader_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReaderClass"></a><h3>struct GArrowJSONReaderClass</h3> |
| <pre class="programlisting">struct GArrowJSONReaderClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions-struct"></a><h3>GArrowCSVReadOptions</h3> |
| <pre class="programlisting">typedef struct _GArrowCSVReadOptions GArrowCSVReadOptions;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReader-struct"></a><h3>GArrowCSVReader</h3> |
| <pre class="programlisting">typedef struct _GArrowCSVReader GArrowCSVReader;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFeatherFileReader-struct"></a><h3>GArrowFeatherFileReader</h3> |
| <pre class="programlisting">typedef struct _GArrowFeatherFileReader GArrowFeatherFileReader;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions-struct"></a><h3>GArrowJSONReadOptions</h3> |
| <pre class="programlisting">typedef struct _GArrowJSONReadOptions GArrowJSONReadOptions;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReader-struct"></a><h3>GArrowJSONReader</h3> |
| <pre class="programlisting">typedef struct _GArrowJSONReader GArrowJSONReader;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchReader-struct"></a><h3>GArrowRecordBatchReader</h3> |
| <pre class="programlisting">typedef struct _GArrowRecordBatchReader GArrowRecordBatchReader;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowTableBatchReader-struct"></a><h3>GArrowTableBatchReader</h3> |
| <pre class="programlisting">typedef struct _GArrowTableBatchReader GArrowTableBatchReader;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="reader-classes.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchFileReader--record-batch-file-reader"></a><h3>The <code class="literal">“record-batch-file-reader”</code> property</h3> |
| <pre class="programlisting"> “record-batch-file-reader” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::ipc::RecordBatchFileReader> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--allow-newlines-in-values"></a><h3>The <code class="literal">“allow-newlines-in-values”</code> property</h3> |
| <pre class="programlisting"> “allow-newlines-in-values” <span class="type">gboolean</span></pre> |
| <p>Whether values are allowed to contain CR (0x0d) and LF (0x0a) characters.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--allow-null-strings"></a><h3>The <code class="literal">“allow-null-strings”</code> property</h3> |
| <pre class="programlisting"> “allow-null-strings” <span class="type">gboolean</span></pre> |
| <p>Whether string / binary columns can have null values. |
| If <code class="literal">TRUE</code>, then strings in "null_values" are considered null for string columns. |
| If <code class="literal">FALSE</code>, then all strings are valid string values.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--block-size"></a><h3>The <code class="literal">“block-size”</code> property</h3> |
| <pre class="programlisting"> “block-size” <span class="type">gint</span></pre> |
| <p>Block size we request from the IO layer; also determines the size |
| of chunks when <a class="link" href="reader-classes.html#GArrowCSVReadOptions--use-threads" title="The “use-threads” property"><span class="type">“use-threads”</span></a> is <code class="literal">TRUE</code>.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 1048576</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--check-utf8"></a><h3>The <code class="literal">“check-utf8”</code> property</h3> |
| <pre class="programlisting"> “check-utf8” <span class="type">gboolean</span></pre> |
| <p>Whether to check UTF8 validity of string columns.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--delimiter"></a><h3>The <code class="literal">“delimiter”</code> property</h3> |
| <pre class="programlisting"> “delimiter” <span class="type">gchar</span></pre> |
| <p>Field delimiter character.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 44</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--escape-character"></a><h3>The <code class="literal">“escape-character”</code> property</h3> |
| <pre class="programlisting"> “escape-character” <span class="type">gchar</span></pre> |
| <p>Escaping character. This is used only when |
| <a class="link" href="reader-classes.html#GArrowCSVReadOptions--is-escaped" title="The “is-escaped” property"><span class="type">“is-escaped”</span></a> is <code class="literal">TRUE</code>.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 92</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--generate-column-names"></a><h3>The <code class="literal">“generate-column-names”</code> property</h3> |
| <pre class="programlisting"> “generate-column-names” <span class="type">gboolean</span></pre> |
| <p>Whether to autogenerate column names if column-names is empty. If TRUE, column names will be of the form 'f0', 'f1'... If FALSE, column names will be read from the first CSV row after n-skip-rows.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--ignore-empty-lines"></a><h3>The <code class="literal">“ignore-empty-lines”</code> property</h3> |
| <pre class="programlisting"> “ignore-empty-lines” <span class="type">gboolean</span></pre> |
| <p>Whether empty lines are ignored. If <code class="literal">FALSE</code>, an empty line |
| represents a simple empty value (assuming a one-column CSV file).</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--is-double-quoted"></a><h3>The <code class="literal">“is-double-quoted”</code> property</h3> |
| <pre class="programlisting"> “is-double-quoted” <span class="type">gboolean</span></pre> |
| <p>Whether a quote inside a value is double quoted.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--is-escaped"></a><h3>The <code class="literal">“is-escaped”</code> property</h3> |
| <pre class="programlisting"> “is-escaped” <span class="type">gboolean</span></pre> |
| <p>Whether escaping is used.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--is-quoted"></a><h3>The <code class="literal">“is-quoted”</code> property</h3> |
| <pre class="programlisting"> “is-quoted” <span class="type">gboolean</span></pre> |
| <p>Whether quoting is used.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--n-skip-rows"></a><h3>The <code class="literal">“n-skip-rows”</code> property</h3> |
| <pre class="programlisting"> “n-skip-rows” <span class="type">guint</span></pre> |
| <p>The number of header rows to skip (not including |
| the row of column names, if any)</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: 0</p> |
| <p class="since">Since: <a class="link" href="api-index-0-15-0.html#api-index-0.15.0">0.15.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--quote-character"></a><h3>The <code class="literal">“quote-character”</code> property</h3> |
| <pre class="programlisting"> “quote-character” <span class="type">gchar</span></pre> |
| <p>Quoting character. This is used only when |
| <a class="link" href="reader-classes.html#GArrowCSVReadOptions--is-quoted" title="The “is-quoted” property"><span class="type">“is-quoted”</span></a> is <code class="literal">TRUE</code>.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 34</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReadOptions--use-threads"></a><h3>The <code class="literal">“use-threads”</code> property</h3> |
| <pre class="programlisting"> “use-threads” <span class="type">gboolean</span></pre> |
| <p>Whether to use the global CPU thread pool.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-12-0.html#api-index-0.12.0">0.12.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowCSVReader--csv-table-reader"></a><h3>The <code class="literal">“csv-table-reader”</code> property</h3> |
| <pre class="programlisting"> “csv-table-reader” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::csv::TableReader> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFeatherFileReader--feather-reader"></a><h3>The <code class="literal">“feather-reader”</code> property</h3> |
| <pre class="programlisting"> “feather-reader” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::ipc::feather::Reader> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions--allow-newlines-in-values"></a><h3>The <code class="literal">“allow-newlines-in-values”</code> property</h3> |
| <pre class="programlisting"> “allow-newlines-in-values” <span class="type">gboolean</span></pre> |
| <p>Whether objects may be printed across multiple lines (for example pretty printed). |
| if <code class="literal">FALSE</code>, input must end with an empty line.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: FALSE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions--block-size"></a><h3>The <code class="literal">“block-size”</code> property</h3> |
| <pre class="programlisting"> “block-size” <span class="type">gint</span></pre> |
| <p>Block size we request from the IO layer; also determines the size |
| of chunks when <a class="link" href="reader-classes.html#GArrowJSONReadOptions--use-threads" title="The “use-threads” property"><span class="type">“use-threads”</span></a> is <code class="literal">TRUE</code>.</p> |
| <p>Flags: Read / Write</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 1048576</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions--schema"></a><h3>The <code class="literal">“schema”</code> property</h3> |
| <pre class="programlisting"> “schema” <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *</pre> |
| <p>Schema for passing custom conversion rules.</p> |
| <p>Flags: Read / Write</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions--unexpected-field-behavior"></a><h3>The <code class="literal">“unexpected-field-behavior”</code> property</h3> |
| <pre class="programlisting"> “unexpected-field-behavior” <a class="link" href="reader-classes.html#GArrowJSONReadUnexpectedFieldBehavior" title="enum GArrowJSONReadUnexpectedFieldBehavior"><span class="type">GArrowJSONReadUnexpectedFieldBehavior</span></a></pre> |
| <p>How to parse handle fields outside the explicit schema.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: GARROW_JSON_READ_INFER_TYPE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReadOptions--use-threads"></a><h3>The <code class="literal">“use-threads”</code> property</h3> |
| <pre class="programlisting"> “use-threads” <span class="type">gboolean</span></pre> |
| <p>Whether to use the global CPU thread pool.</p> |
| <p>Flags: Read / Write</p> |
| <p>Default value: TRUE</p> |
| <p class="since">Since: <a class="link" href="api-index-0-14-0.html#api-index-0.14.0">0.14.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowJSONReader--json-table-reader"></a><h3>The <code class="literal">“json-table-reader”</code> property</h3> |
| <pre class="programlisting"> “json-table-reader” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::json::TableReader> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchReader--record-batch-reader"></a><h3>The <code class="literal">“record-batch-reader”</code> property</h3> |
| <pre class="programlisting"> “record-batch-reader” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::ipc::RecordBatchRecordBatchReader> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |