Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 07E0B200D2E for ; Mon, 16 Oct 2017 16:19:44 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 0620C1609EF; Mon, 16 Oct 2017 14:19:44 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id BFB1F160BF9 for ; Mon, 16 Oct 2017 16:19:41 +0200 (CEST) Received: (qmail 90232 invoked by uid 500); 16 Oct 2017 14:19:41 -0000 Mailing-List: contact commits-help@arrow.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@arrow.apache.org Delivered-To: mailing list commits@arrow.apache.org Received: (qmail 89991 invoked by uid 99); 16 Oct 2017 14:19:40 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 16 Oct 2017 14:19:40 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4F098DFF81; Mon, 16 Oct 2017 14:19:40 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: wesm@apache.org To: commits@arrow.apache.org Date: Mon, 16 Oct 2017 14:19:57 -0000 Message-Id: In-Reply-To: <7c9f1061d5dc49e4b51356bc4d9a83d8@git.apache.org> References: <7c9f1061d5dc49e4b51356bc4d9a83d8@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [19/51] [partial] arrow-site git commit: Add Ray serialization blog post, update API docs archived-at: Mon, 16 Oct 2017 14:19:44 -0000 http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7a2e5ece/docs/cpp/reader_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/reader_8h_source.html b/docs/cpp/reader_8h_source.html index 186e044..eefc49f 100644 --- a/docs/cpp/reader_8h_source.html +++ b/docs/cpp/reader_8h_source.html @@ -5,7 +5,7 @@ -Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/ipc/reader.h Source File +Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/ipc/reader.h Source File @@ -67,13 +67,13 @@ $(function() {
reader.h
-Go to the documentation of this file.
1 // Licensed to the Apache Software Foundation (ASF) under one
2 // or more contributor license agreements. See the NOTICE file
3 // distributed with this work for additional information
4 // regarding copyright ownership. The ASF licenses this file
5 // to you under the Apache License, Version 2.0 (the
6 // "License"); you may not use this file except in compliance
7 // with the License. You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing,
12 // software distributed un der the License is distributed on an
13 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 // KIND, either express or implied. See the License for the
15 // specific language governing permissions and limitations
16 // under the License.
17 
18 // Read Arrow files and streams
19 
20 #ifndef ARROW_IPC_READER_H
21 #define ARROW_IPC_READER_H
22 
23 #include <cstdint>
24 #include <memory>
25 
26 #include "arrow/ipc/message.h"
27 #include "arrow/table.h"
28 #include "arrow/util/visibility.h"
29 
30 namespace arrow {
31 
32 class Buffer;
33 class RecordBatch;
34 class Schema;
35 class Status;
36 class Tensor;
37 
38 namespace io {
39 
40 class InputStream;
41 class RandomAccessFile;
42 
43 } // namespace io
44 
45 namespace ipc {
46 
47 using RecordBatchReader = ::arrow::RecordBatchReader;
48 
51 class ARROW_EXPORT RecordBatchStreamReader : public RecordBatchReader {
52  public:
53  virtual ~RecordBatchStreamReader();
54 
60  static Status Open(std::unique_ptr& lt;MessageReader> message_reader,
61  std::shared_ptr<RecordBatchReader>* out);
62 
63 #ifndef ARROW_NO_DEPRECATED_API
64  static Status Open(std::unique_ptr<MessageReader> message_reader,
66  std::shared_ptr<RecordBatchStreamReader>* out);
67 
69  static Status Open(const std::shared_ptr<io::InputStream>& stream,
70  std::shared_ptr<RecordBatchStreamReader>* out);
71 #endif
72 
79  static Status Open(io::InputStream* stream, std::shared_ptr<RecordBatchReader>* out);
80 
82  static Status Open(const std::shared_ptr<io::InputStream>& stream,
83  std::shared_ptr<RecordBatchReader>* out);
84 
85  std::shared_ptr<Schema> schema() const override;
86  Status ReadNext(std::shared_ptr<RecordBatch>* batch) override;
87 
88  private:
89  RecordBatchStreamReader();
90 
91  class ARROW_NO_EXPORT RecordBatchStreamReaderImpl;
92  std::unique_ptr<RecordBatchStreamReaderImpl> impl_;
93 };
94 60;
96 class ARROW_EXPORT RecordBatchFileReader {
97  public:
98  ~RecordBatchFileReader();
99 
101  // Open a file-like object that is assumed to be self-contained; i.e., the
102  // end of the file interface is the end of the Arrow file. Note that there
103  // can be any amount of data preceding the Arrow-formatted data, because we
104  // need only locate the end of the Arrow file stream to discover the metadata
105  // and then proceed to read the data into memory.
106  static Status Open(io::RandomAccessFile* file,
107< /span>  std::shared_ptr<RecordBatchFileReader>* reader);
108 
117  static Status Open(io::RandomAccessFile* file, int64_t footer_offset,
118  std::shared_ptr<RecordBatchFileReader>* reader);
119 
121  static Status Open(const std::shared_ptr<io::RandomAccessFile>& f ile,
122  std::shared_ptr<RecordBatchFileReader>* reader);
123 
125  static Status Open(const std::shared_ptr<io::RandomAccessFile>& file,
126  int64_t footer_offset,
127  std::shared_ptr<RecordBatchFileReader>* reader);
128 
130  std::shared_ptr&l t;Schema> schema() const;
131 
133  int num_record_batches() const;
134 
136  MetadataVersion version() const;
137 
144  Status ReadRecordBatch(int i, std::shared_ptr<RecordBatch>* batch);
145 
146  private:
147  RecordBatchFileReader();
148 
149  class ARROW_NO_EXPORT RecordBatchFileReaderImpl;
150  std::unique_ptr<RecordBatchFileReaderImpl> impl_;
151 };
152 
153 // Generic read functions; does not copy data if the input supports zero copy reads
154 
162 ARROW_EXPORT
163 Status ReadSchema(io::InputStream* stream, std::shared_ptr<Schema>* out);
164 
172 ARROW_EXPORT
173 Status ReadRecordBatch(const std::shared_ptr<Schema>& schema, io::InputStream* stream,
174  std::shared_ptr<RecordBatch>* out);
175 
182 ARROW_EXPORT
183 Status ReadRecordBatch(const Buffer& metadata, const std::shared_ptr<Schema>& schema,
184  io::RandomAccessFile* file, std::shared_ptr<RecordBatch>* out);
185 
192 ARROW_EXPORT
193 Status ReadRecordBatch(const Message& message, const std::shared_ptr<Schema>& schema,
194  std::shared_ptr<RecordBatch>* out);
195 
203 ARROW_EXPORT
204 Status ReadRecordBatch(const Buffer& metadata, const std::shared_ptr<Schema >& schema,
205  int max_recursion_depth, io::RandomAccessFile* file,
206  std::shared_ptr<RecordBatch>* out);
207 
213 ARROW_EXPORT
214 Status ReadTensor(int64_t offset, io::RandomAccessFile* file,
215  std::shared_ptr<Tensor>* out);
216 
217 #ifndef ARROW_NO_DEPRECATED_API
218 ARROW_EXPORT
222 Status ReadRecordBatch(const std::shared_ptr<Schema>& schema, int64_t offset,
223  io::RandomAccessFile* stream, std::sha red_ptr<RecordBatch>* out);
224 #endif
225 
226 } // namespace ipc
227 } // namespace arrow
228 
229 #endif // ARROW_IPC_READER_H
arrow::ipc::ReadTensor
Status ReadTensor(int64_t o ffset, io::RandomAccessFile *file, std::shared_ptr< Tensor > *out)
EXPERIMENTAL: Read arrow::Tensor as encapsulated IPC message in file.
+Go to the documentation of this file.
1 // Licensed to the Apache Software Foundation (ASF) under one
2 // or more contributor license agreements. See the NOTICE file
3 // distributed with this work for additional information
4 // regarding copyright ownership. The ASF licenses this file
5 // to you under the Apache License, Version 2.0 (the
6 // "License"); you may not use this file except in compliance
7 // with the License. You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing,
12 // software distributed un der the License is distributed on an
13 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 // KIND, either express or implied. See the License for the
15 // specific language governing permissions and limitations
16 // under the License.
17 
18 // Read Arrow files and streams
19 
20 #ifndef ARROW_IPC_READER_H
21 #define ARROW_IPC_READER_H
22 
23 #include <cstdint>
24 #include <memory>
25 
26 #include "arrow/ipc/message.h"
27 #include "arrow/table.h"
28 #include "arrow/util/visibility.h"
29 
30 namespace arrow {
31 
32 class Buffer;
33 class RecordBatch;
34 class Schema;
35 class Status;
36 class Tensor;
37 
38 namespace io {
39 
40 class InputStream;
41 class RandomAccessFile;
42 
43 } // namespace io
44 
45 namespace ipc {
46 
47 using RecordBatchReader = ::arrow::RecordBatchReader;
48 
51 class ARROW_EXPORT RecordBatchStreamReader : public RecordBatchReader {
52  public:
53  virtual ~RecordBatchStreamReader();
54 
60  static Status Open(std::unique_ptr& lt;MessageReader> message_reader,
61  std::shared_ptr<RecordBatchReader>* out);
62 
63 #ifndef ARROW_NO_DEPRECATED_API
64  static Status Open(std::unique_ptr<MessageReader> message_reader,
66  std::shared_ptr<RecordBatchStreamReader>* out);
67 
69  static Status Open(const std::shared_ptr<io::InputStream>& stream,
70  std::shared_ptr<RecordBatchStreamReader>* out);
71 #endif
72 
79  static Status Open(io::InputStream* stream, std::shared_ptr<RecordBatchReader>* out);
80 
82  static Status Open(const std::shared_ptr<io::InputStream>& stream,
83  std::shared_ptr<RecordBatchReader>* out);
84 
85  std::shared_ptr<Schema> schema() const override;
86  Status ReadNext(std::shared_ptr<RecordBatch>* batch) override;
87 
88  private:
89  RecordBatchStreamReader();
90 
91  class ARROW_NO_EXPORT RecordBatchStreamReaderImpl;
92  std::unique_ptr<RecordBatchStreamReaderImpl> impl_;
93 };
94 60;
96 class ARROW_EXPORT RecordBatchFileReader {
97  public:
98  ~RecordBatchFileReader();
99 
101  // Open a file-like object that is assumed to be self-contained; i.e., the
102  // end of the file interface is the end of the Arrow file. Note that there
103  // can be any amount of data preceding the Arrow-formatted data, because we
104  // need only locate the end of the Arrow file stream to discover the metadata
105  // and then proceed to read the data into memory.
106  static Status Open(io::RandomAccessFile* file,
107< /span>  std::shared_ptr<RecordBatchFileReader>* reader);
108 
117  static Status Open(io::RandomAccessFile* file, int64_t footer_offset,
118  std::shared_ptr<RecordBatchFileReader>* reader);
119 
121  static Status Open(const std::shared_ptr<io::RandomAccessFile>& f ile,
122  std::shared_ptr<RecordBatchFileReader>* reader);
123 
125  static Status Open(const std::shared_ptr<io::RandomAccessFile>& file,
126  int64_t footer_offset,
127  std::shared_ptr<RecordBatchFileReader>* reader);
128 
130  std::shared_ptr&l t;Schema> schema() const;
131 
133  int num_record_batches() const;
134 
136  MetadataVersion version() const;
137 
144  Status ReadRecordBatch(int i, std::shared_ptr<RecordBatch>* batch);
145 
146  private:
147  RecordBatchFileReader();
148 
149  class ARROW_NO_EXPORT RecordBatchFileReaderImpl;
150  std::unique_ptr<RecordBatchFileReaderImpl> impl_;
151 };
152 
153 // Generic read functions; does not copy data if the input supports zero copy reads
154 
162 ARROW_EXPORT
163 Status ReadSchema(io::InputStream* stream, std::shared_ptr<Schema>* out);
164 
171 ARROW_EXPORT
172 Status ReadRecordBatch(const std::shared_ptr<Schema>& schema, io::InputStream* stream,
173  std::shared_ptr<RecordBatch>* out);
174 
181 ARROW_EXPORT
182 Status ReadRecordBatch(const Buffer& metadata, const std::shared_ptr<Schema>& schema,
183  io::RandomAccessFile* file, std::shared_ptr<RecordBatch>* out);
184 
191 ARROW_EXPORT
192 Status ReadRecordBatch(const Message& message, const std::shared_ptr<Schema>& schema,
193  std::shared_ptr<RecordBatch>* out);
194 
202 ARROW_EXPORT
203 Status ReadRecordBatch(const Buffer& metadata, const std::shared_ptr<Schema >& schema,
204  int max_recursion_depth, io::RandomAccessFile* file,
205  std::shared_ptr<RecordBatch>* out);
206 
212 ARROW_EXPORT
213 Status ReadTensor(int64_t offset, io::RandomAccessFile* file,
214  std::shared_ptr<Tensor>* out);
215 
216 #ifndef ARROW_NO_DEPRECATED_API
217 ARROW_EXPORT
221 Status ReadRecordBatch(const std::shared_ptr<Schema>& schema, int64_t offset,
222  io::RandomAccessFile* stream, std::sha red_ptr<RecordBatch>* out);
223 #endif
224 
225 } // namespace ipc
226 } // namespace arrow
227 
228 #endif // ARROW_IPC_READER_H
arrow::ipc::ReadTensor
Status ReadTensor(int64_t o ffset, io::RandomAccessFile *file, std::shared_ptr< Tensor > *out)
EXPERIMENTAL: Read arrow::Tensor as encapsulated IPC message in file.
arrow::ipc::Message
An IPC message including metadata and body.
Definition: message.h:57
arrow::schema
std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=nullptr)
Create a Schema instance.
arrow::RecordBatchReader
Abstract interface for reading stream of record batches.
Definition: table.h:276
-
arrow::io::InputStream
Definition: interfaces.h:115
+
arrow::io::InputStream
Definition: interfaces.h:120
ARROW_NO_EXPORT
#define ARROW_NO_EXPORT
Definition: visibility.h:40
-
arrow::io::RandomAccessFile
Definition: interfaces.h:120
+
arrow::io::RandomAccessFile
Definition: interfaces.h:125
arrow::Status
Definition: status.h:106
arrow::ipc::RecordBatchStreamReader
Synchronous batch stream reader that reads from io::InputStream.
Definition: reader.h:51
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/7a2e5ece/docs/cpp/rle-encoding_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/rle-encoding_8h.html b/docs/cpp/rle-encoding_8h.html index 83a43b9..dce3104 100644 --- a/docs/cpp/rle-encoding_8h.html +++ b/docs/cpp/rle-encoding_8h.html @@ -5,7 +5,7 @@ -Apache Arrow (C++): /home/wesm/code/arrow/cpp/src/arrow/util/rle-encoding.h File Reference +Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/util/rle-encoding.h File Reference