forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtable_builder.h
More file actions
138 lines (113 loc) · 5.22 KB
/
Copy pathtable_builder.h
File metadata and controls
138 lines (113 loc) · 5.22 KB
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
// 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 <cstdint>
#include <memory>
#include <vector>
#include "arrow/array/builder_base.h"
#include "arrow/status.h"
#include "arrow/type.h"
#include "arrow/util/checked_cast.h"
#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"
namespace arrow {
class MemoryPool;
class RecordBatch;
/// \class RecordBatchBuilder
/// \brief Helper class for creating record batches iteratively given a known
/// schema
class ARROW_EXPORT RecordBatchBuilder {
public:
/// \brief Create and initialize a RecordBatchBuilder
/// \param[in] schema The schema for the record batch
/// \param[in] pool A MemoryPool to use for allocations
/// \param[in] builder the created builder instance
ARROW_DEPRECATED("Deprecated in 9.0.0. Use Result-returning variant.")
static Status Make(const std::shared_ptr<Schema>& schema, MemoryPool* pool,
std::unique_ptr<RecordBatchBuilder>* builder);
/// \brief Create and initialize a RecordBatchBuilder
/// \param[in] schema The schema for the record batch
/// \param[in] pool A MemoryPool to use for allocations
/// \param[in] initial_capacity The initial capacity for the builders
/// \param[in] builder the created builder instance
ARROW_DEPRECATED("Deprecated in 9.0.0. Use Result-returning variant.")
static Status Make(const std::shared_ptr<Schema>& schema, MemoryPool* pool,
int64_t initial_capacity,
std::unique_ptr<RecordBatchBuilder>* builder);
/// \brief Create and initialize a RecordBatchBuilder
/// \param[in] schema The schema for the record batch
/// \param[in] pool A MemoryPool to use for allocations
/// \return the created builder instance
static Result<std::unique_ptr<RecordBatchBuilder>> Make(
const std::shared_ptr<Schema>& schema, MemoryPool* pool);
/// \brief Create and initialize a RecordBatchBuilder
/// \param[in] schema The schema for the record batch
/// \param[in] pool A MemoryPool to use for allocations
/// \param[in] initial_capacity The initial capacity for the builders
/// \return the created builder instance
static Result<std::unique_ptr<RecordBatchBuilder>> Make(
const std::shared_ptr<Schema>& schema, MemoryPool* pool, int64_t initial_capacity);
/// \brief Get base pointer to field builder
/// \param i the field index
/// \return pointer to ArrayBuilder
ArrayBuilder* GetField(int i) { return raw_field_builders_[i]; }
/// \brief Return field builder casted to indicated specific builder type
/// \param i the field index
/// \return pointer to template type
template <typename T>
T* GetFieldAs(int i) {
return internal::checked_cast<T*>(raw_field_builders_[i]);
}
/// \brief Finish current batch and optionally reset
/// \param[in] reset_builders the resulting RecordBatch
/// \param[out] batch the resulting RecordBatch
/// \return Status
ARROW_DEPRECATED("Deprecated in 9.0.0. Use Result-returning variant.")
Status Flush(bool reset_builders, std::shared_ptr<RecordBatch>* batch);
/// \brief Finish current batch and reset
/// \param[out] batch the resulting RecordBatch
/// \return Status
ARROW_DEPRECATED("Deprecated in 9.0.0. Use Result-returning variant.")
Status Flush(std::shared_ptr<RecordBatch>* batch);
/// \brief Finish current batch and optionally reset
/// \param[in] reset_builders the resulting RecordBatch
/// \return the resulting RecordBatch
Result<std::shared_ptr<RecordBatch>> Flush(bool reset_builders);
/// \brief Finish current batch and reset
/// \return the resulting RecordBatch
Result<std::shared_ptr<RecordBatch>> Flush();
/// \brief Set the initial capacity for new builders
void SetInitialCapacity(int64_t capacity);
/// \brief The initial capacity for builders
int64_t initial_capacity() const { return initial_capacity_; }
/// \brief The number of fields in the schema
int num_fields() const { return schema_->num_fields(); }
/// \brief The number of fields in the schema
std::shared_ptr<Schema> schema() const { return schema_; }
private:
ARROW_DISALLOW_COPY_AND_ASSIGN(RecordBatchBuilder);
RecordBatchBuilder(const std::shared_ptr<Schema>& schema, MemoryPool* pool,
int64_t initial_capacity);
Status CreateBuilders();
Status InitBuilders();
std::shared_ptr<Schema> schema_;
int64_t initial_capacity_;
MemoryPool* pool_;
std::vector<std::unique_ptr<ArrayBuilder>> field_builders_;
std::vector<ArrayBuilder*> raw_field_builders_;
};
} // namespace arrow