summaryrefslogtreecommitdiffstats
path: root/src/arrow/c_glib/arrow-glib/writer.h
blob: a0d22fe626c0b854d248fe15cfc42f4e4c8287de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#pragma once

#include <arrow-glib/array.h>
#include <arrow-glib/record-batch.h>
#include <arrow-glib/schema.h>

#include <arrow-glib/output-stream.h>

G_BEGIN_DECLS

#define GARROW_TYPE_RECORD_BATCH_WRITER         \
  (garrow_record_batch_writer_get_type())
#define GARROW_RECORD_BATCH_WRITER(obj)                         \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),                            \
                              GARROW_TYPE_RECORD_BATCH_WRITER,  \
                              GArrowRecordBatchWriter))
#define GARROW_RECORD_BATCH_WRITER_CLASS(klass)                 \
  (G_TYPE_CHECK_CLASS_CAST((klass),                             \
                           GARROW_TYPE_RECORD_BATCH_WRITER,     \
                           GArrowRecordBatchWriterClass))
#define GARROW_IS_RECORD_BATCH_WRITER(obj)                      \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),                            \
                              GARROW_TYPE_RECORD_BATCH_WRITER))
#define GARROW_IS_RECORD_BATCH_WRITER_CLASS(klass)              \
  (G_TYPE_CHECK_CLASS_TYPE((klass),                             \
                           GARROW_TYPE_RECORD_BATCH_WRITER))
#define GARROW_RECORD_BATCH_WRITER_GET_CLASS(obj)               \
  (G_TYPE_INSTANCE_GET_CLASS((obj),                             \
                             GARROW_TYPE_RECORD_BATCH_WRITER,   \
                             GArrowRecordBatchWriterClass))

typedef struct _GArrowRecordBatchWriter         GArrowRecordBatchWriter;
#ifndef __GTK_DOC_IGNORE__
typedef struct _GArrowRecordBatchWriterClass    GArrowRecordBatchWriterClass;
#endif

/**
 * GArrowRecordBatchWriter:
 *
 * It wraps `arrow::ipc::RecordBatchWriter`.
 */
struct _GArrowRecordBatchWriter
{
  /*< private >*/
  GObject parent_instance;
};

#ifndef __GTK_DOC_IGNORE__
struct _GArrowRecordBatchWriterClass
{
  GObjectClass parent_class;
};
#endif

GType garrow_record_batch_writer_get_type(void) G_GNUC_CONST;

gboolean garrow_record_batch_writer_write_record_batch(
  GArrowRecordBatchWriter *writer,
  GArrowRecordBatch *record_batch,
  GError **error);
gboolean garrow_record_batch_writer_write_table(
  GArrowRecordBatchWriter *writer,
  GArrowTable *table,
  GError **error);
gboolean garrow_record_batch_writer_close(
  GArrowRecordBatchWriter *writer,
  GError **error);


#define GARROW_TYPE_RECORD_BATCH_STREAM_WRITER          \
  (garrow_record_batch_stream_writer_get_type())
#define GARROW_RECORD_BATCH_STREAM_WRITER(obj)                          \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),                                    \
                              GARROW_TYPE_RECORD_BATCH_STREAM_WRITER,   \
                              GArrowRecordBatchStreamWriter))
#define GARROW_RECORD_BATCH_STREAM_WRITER_CLASS(klass)                  \
  (G_TYPE_CHECK_CLASS_CAST((klass),                                     \
                           GARROW_TYPE_RECORD_BATCH_STREAM_WRITER,      \
                           GArrowRecordBatchStreamWriterClass))
#define GARROW_IS_RECORD_BATCH_STREAM_WRITER(obj)                       \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),                                    \
                              GARROW_TYPE_RECORD_BATCH_STREAM_WRITER))
#define GARROW_IS_RECORD_BATCH_STREAM_WRITER_CLASS(klass)            \
  (G_TYPE_CHECK_CLASS_TYPE((klass),                     \
                           GARROW_TYPE_RECORD_BATCH_STREAM_WRITER))
#define GARROW_RECORD_BATCH_STREAM_WRITER_GET_CLASS(obj)             \
  (G_TYPE_INSTANCE_GET_CLASS((obj),                     \
                             GARROW_TYPE_RECORD_BATCH_STREAM_WRITER, \
                             GArrowRecordBatchStreamWriterClass))

typedef struct _GArrowRecordBatchStreamWriter      GArrowRecordBatchStreamWriter;
#ifndef __GTK_DOC_IGNORE__
typedef struct _GArrowRecordBatchStreamWriterClass GArrowRecordBatchStreamWriterClass;
#endif

/**
 * GArrowRecordBatchStreamWriter:
 *
 * It wraps `arrow::ipc::RecordBatchStreamWriter`.
 */
struct _GArrowRecordBatchStreamWriter
{
  /*< private >*/
  GArrowRecordBatchWriter parent_instance;
};

#ifndef __GTK_DOC_IGNORE__
struct _GArrowRecordBatchStreamWriterClass
{
  GArrowRecordBatchWriterClass parent_class;
};
#endif

GType garrow_record_batch_stream_writer_get_type(void) G_GNUC_CONST;

GArrowRecordBatchStreamWriter *garrow_record_batch_stream_writer_new(
  GArrowOutputStream *sink,
  GArrowSchema *schema,
  GError **error);


#define GARROW_TYPE_RECORD_BATCH_FILE_WRITER    \
  (garrow_record_batch_file_writer_get_type())
#define GARROW_RECORD_BATCH_FILE_WRITER(obj)                            \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),                                    \
                              GARROW_TYPE_RECORD_BATCH_FILE_WRITER,     \
                              GArrowRecordBatchFileWriter))
#define GARROW_RECORD_BATCH_FILE_WRITER_CLASS(klass)                    \
  (G_TYPE_CHECK_CLASS_CAST((klass),                                     \
                           GARROW_TYPE_RECORD_BATCH_FILE_WRITER,        \
                           GArrowRecordBatchFileWriterClass))
#define GARROW_IS_RECORD_BATCH_FILE_WRITER(obj)                         \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),                                    \
                              GARROW_TYPE_RECORD_BATCH_FILE_WRITER))
#define GARROW_IS_RECORD_BATCH_FILE_WRITER_CLASS(klass)                 \
  (G_TYPE_CHECK_CLASS_TYPE((klass),                                     \
                           GARROW_TYPE_RECORD_BATCH_FILE_WRITER))
#define GARROW_RECORD_BATCH_FILE_WRITER_GET_CLASS(obj)                  \
  (G_TYPE_INSTANCE_GET_CLASS((obj),                                     \
                             GARROW_TYPE_RECORD_BATCH_FILE_WRITER,      \
                             GArrowRecordBatchFileWriterClass))

typedef struct _GArrowRecordBatchFileWriter      GArrowRecordBatchFileWriter;
#ifndef __GTK_DOC_IGNORE__
typedef struct _GArrowRecordBatchFileWriterClass GArrowRecordBatchFileWriterClass;
#endif

/**
 * GArrowRecordBatchFileWriter:
 *
 * It wraps `arrow::ipc::RecordBatchFileWriter`.
 */
struct _GArrowRecordBatchFileWriter
{
  /*< private >*/
  GArrowRecordBatchStreamWriter parent_instance;
};

#ifndef __GTK_DOC_IGNORE__
struct _GArrowRecordBatchFileWriterClass
{
  GArrowRecordBatchStreamWriterClass parent_class;
};
#endif

GType garrow_record_batch_file_writer_get_type(void) G_GNUC_CONST;

GArrowRecordBatchFileWriter *garrow_record_batch_file_writer_new(
  GArrowOutputStream *sink,
  GArrowSchema *schema,
  GError **error);

G_END_DECLS