Skip to content

Commit ea9bc83

Browse files
kouxhochy
kou
authored and
xhochy
committed
ARROW-1229: [GLib] Use "read" instead of "get" for reading record batch
It follows C++ API change. Author: Kouhei Sutou <[email protected]> Closes #858 from kou/glib-use-read and squashes the following commits: 6fc499e [Kouhei Sutou] [GLib] Use "read" instead of "get" for reading record batch
1 parent b474cac commit ea9bc83

File tree

11 files changed

+70
-14
lines changed

11 files changed

+70
-14
lines changed

‎c_glib/arrow-glib/reader.cpp

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,18 +166,38 @@ garrow_record_batch_reader_get_schema(GArrowRecordBatchReader *reader)
166166
* The next record batch in the stream or %NULL on end of stream.
167167
*
168168
* Since: 0.4.0
169+
*
170+
* Deprecated: 0.5.0:
171+
* Use garrow_record_batch_reader_read_next_record_batch() instead.
169172
*/
170173
GArrowRecordBatch *
171174
garrow_record_batch_reader_get_next_record_batch(GArrowRecordBatchReader *reader,
172175
GError **error)
176+
{
177+
return garrow_record_batch_reader_read_next_record_batch(reader, error);
178+
}
179+
180+
/**
181+
* garrow_record_batch_reader_read_next_record_batch:
182+
* @reader: A #GArrowRecordBatchReader.
183+
* @error: (nullable): Return locatipcn for a #GError or %NULL.
184+
*
185+
* Returns: (nullable) (transfer full):
186+
* The next record batch in the stream or %NULL on end of stream.
187+
*
188+
* Since: 0.5.0
189+
*/
190+
GArrowRecordBatch *
191+
garrow_record_batch_reader_read_next_record_batch(GArrowRecordBatchReader *reader,
192+
GError **error)
173193
{
174194
auto arrow_reader = garrow_record_batch_reader_get_raw(reader);
175195
std::shared_ptr<arrow::RecordBatch> arrow_record_batch;
176196
auto status = arrow_reader->ReadNextRecordBatch(&arrow_record_batch);
177197

178198
if (garrow_error_check(error,
179199
status,
180-
"[record-batch-reader][get-next-record-batch]")) {
200+
"[record-batch-reader][read-next-record-batch]")) {
181201
if (arrow_record_batch == nullptr) {
182202
return NULL;
183203
} else {
@@ -402,19 +422,41 @@ garrow_record_batch_file_reader_get_version(GArrowRecordBatchFileReader *reader)
402422
* The i-th record batch in the file or %NULL on error.
403423
*
404424
* Since: 0.4.0
425+
*
426+
* Deprecated: 0.5.0:
427+
* Use garrow_record_batch_file_reader_read_record_batch() instead.
405428
*/
406429
GArrowRecordBatch *
407430
garrow_record_batch_file_reader_get_record_batch(GArrowRecordBatchFileReader *reader,
408431
guint i,
409432
GError **error)
433+
{
434+
return garrow_record_batch_file_reader_read_record_batch(reader, i, error);
435+
}
436+
437+
/**
438+
* garrow_record_batch_file_reader_read_record_batch:
439+
* @reader: A #GArrowRecordBatchFileReader.
440+
* @i: The index of the target record batch.
441+
* @error: (nullable): Return locatipcn for a #GError or %NULL.
442+
*
443+
* Returns: (nullable) (transfer full):
444+
* The i-th record batch in the file or %NULL on error.
445+
*
446+
* Since: 0.5.0
447+
*/
448+
GArrowRecordBatch *
449+
garrow_record_batch_file_reader_read_record_batch(GArrowRecordBatchFileReader *reader,
450+
guint i,
451+
GError **error)
410452
{
411453
auto arrow_reader = garrow_record_batch_file_reader_get_raw(reader);
412454
std::shared_ptr<arrow::RecordBatch> arrow_record_batch;
413455
auto status = arrow_reader->ReadRecordBatch(i, &arrow_record_batch);
414456

415457
if (garrow_error_check(error,
416458
status,
417-
"[record-batch-file-reader][get-record-batch]")) {
459+
"[record-batch-file-reader][read-record-batch]")) {
418460
return garrow_record_batch_new_raw(&arrow_record_batch);
419461
} else {
420462
return NULL;

‎c_glib/arrow-glib/reader.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,15 @@ GType garrow_record_batch_reader_get_type(void) G_GNUC_CONST;
7676

7777
GArrowSchema *garrow_record_batch_reader_get_schema(
7878
GArrowRecordBatchReader *reader);
79+
#ifndef GARROW_DISABLE_DEPRECATED
80+
G_GNUC_DEPRECATED_FOR(garrow_record_batch_reader_read_next_record_batch)
7981
GArrowRecordBatch *garrow_record_batch_reader_get_next_record_batch(
8082
GArrowRecordBatchReader *reader,
8183
GError **error);
84+
#endif
85+
GArrowRecordBatch *garrow_record_batch_reader_read_next_record_batch(
86+
GArrowRecordBatchReader *reader,
87+
GError **error);
8288

8389

8490
#define GARROW_TYPE_RECORD_BATCH_STREAM_READER \
@@ -188,10 +194,17 @@ guint garrow_record_batch_file_reader_get_n_record_batches(
188194
GArrowRecordBatchFileReader *reader);
189195
GArrowMetadataVersion garrow_record_batch_file_reader_get_version(
190196
GArrowRecordBatchFileReader *reader);
197+
#ifndef GARROW_DISABLE_DEPRECATED
198+
G_GNUC_DEPRECATED_FOR(garrow_record_batch_file_reader_read_record_batch)
191199
GArrowRecordBatch *garrow_record_batch_file_reader_get_record_batch(
192200
GArrowRecordBatchFileReader *reader,
193201
guint i,
194202
GError **error);
203+
#endif
204+
GArrowRecordBatch *garrow_record_batch_file_reader_read_record_batch(
205+
GArrowRecordBatchFileReader *reader,
206+
guint i,
207+
GError **error);
195208

196209

197210
#define GARROW_TYPE_FEATHER_FILE_READER \

‎c_glib/example/Makefile.am

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ SUBDIRS = \
2020

2121
AM_CPPFLAGS = \
2222
-I$(top_builddir) \
23-
-I$(top_srcdir)
23+
-I$(top_srcdir) \
24+
-DGARROW_DISABLE_DEPRECATED
2425

2526
AM_CFLAGS = \
2627
$(GLIB_CFLAGS) \

‎c_glib/example/go/read-batch.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ func main() {
8989
var i uint32
9090
nRecordBatches := reader.GetNRecordBatches()
9191
for i = 0; i < nRecordBatches; i++ {
92-
recordBatch, err := reader.GetRecordBatch(i)
92+
recordBatch, err := reader.ReadRecordBatch(i)
9393
if err != nil {
94-
log.Fatalf("Failed to get record batch[%d]: %v", i, err)
94+
log.Fatalf("Failed to read record batch[%d]: %v", i, err)
9595
}
9696
fmt.Println(strings.Repeat("=", 40))
9797
fmt.Printf("record-batch[%d]:\n", i)

‎c_glib/example/go/read-stream.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ func main() {
8787
log.Fatalf("Failed to parse data: %v", err)
8888
}
8989
for i := 0; true; i++ {
90-
recordBatch, err := reader.GetNextRecordBatch()
90+
recordBatch, err := reader.ReadNextRecordBatch()
9191
if err != nil {
92-
log.Fatalf("Failed to get next record batch: %v", err)
92+
log.Fatalf("Failed to read next record batch: %v", err)
9393
}
9494
if recordBatch == nil {
9595
break

‎c_glib/example/lua/read-batch.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ local input = Arrow.MemoryMappedInputStream.new(input_path)
2424
local reader = Arrow.RecordBatchFileReader.new(input)
2525

2626
for i = 0, reader:get_n_record_batches() - 1 do
27-
local record_batch = reader:get_record_batch(i)
27+
local record_batch = reader:read_record_batch(i)
2828
print(string.rep("=", 40))
2929
print("record-batch["..i.."]:")
3030
for j = 0, record_batch:get_n_columns() - 1 do

‎c_glib/example/lua/read-stream.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ local reader = Arrow.RecordBatchStreamReader.new(input)
2525

2626
local i = 0
2727
while true do
28-
local record_batch = reader:get_next_record_batch()
28+
local record_batch = reader:read_next_record_batch()
2929
if not record_batch then
3030
break
3131
end

‎c_glib/example/lua/stream-to-torch-tensor.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ local reader = Arrow.RecordBatchStreamReader.new(input)
8181

8282
local i = 0
8383
while true do
84-
local record_batch = reader:get_next_record_batch()
84+
local record_batch = reader:read_next_record_batch()
8585
if not record_batch then
8686
break
8787
end

‎c_glib/example/read-batch.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ main(int argc, char **argv)
121121
GArrowRecordBatch *record_batch;
122122

123123
record_batch =
124-
garrow_record_batch_file_reader_get_record_batch(reader, i, &error);
124+
garrow_record_batch_file_reader_read_record_batch(reader, i, &error);
125125
if (!record_batch) {
126126
g_print("failed to open file reader: %s\n", error->message);
127127
g_error_free(error);

‎c_glib/example/read-stream.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ main(int argc, char **argv)
118118
GArrowRecordBatch *record_batch;
119119

120120
record_batch =
121-
garrow_record_batch_reader_get_next_record_batch(reader, &error);
121+
garrow_record_batch_reader_read_next_record_batch(reader, &error);
122122
if (error) {
123123
g_print("failed to get record batch: %s\n", error->message);
124124
g_error_free(error);

‎c_glib/test/test-stream-writer.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ def test_write_record_batch
4444
assert_equal(["enabled"],
4545
stream_reader.schema.fields.collect(&:name))
4646
assert_equal(true,
47-
stream_reader.next_record_batch.get_column(0).get_value(0))
48-
assert_nil(stream_reader.next_record_batch)
47+
stream_reader.read_next_record_batch.get_column(0).get_value(0))
48+
assert_nil(stream_reader.read_next_record_batch)
4949
ensure
5050
input.close
5151
end

0 commit comments

Comments
 (0)