File: streaming-pull-reader.rb

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (243 lines) | stat: -rw-r--r-- 6,939 bytes parent folder | download
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# 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.

require_relative "array"
require_relative "error"
require_relative "field"
require_relative "readable"
require_relative "record-batch"
require_relative "schema"
require_relative "type"

module ArrowFormat
  class MessagePullReader
    CONTINUATION_TYPE = :s32
    CONTINUATION_SIZE = IO::Buffer.size_of(CONTINUATION_TYPE)
    CONTINUATION_STRING = "\xFF\xFF\xFF\xFF".b.freeze
    CONTINUATION_INT32 = -1
    METADATA_LENGTH_TYPE = :s32
    METADATA_LENGTH_SIZE = IO::Buffer.size_of(METADATA_LENGTH_TYPE)

    def initialize(&on_read)
      @on_read = on_read
      @buffer = IO::Buffer.new(0)
      @metadata_length = nil
      @body_length = nil
      @state = :initial
    end

    def next_required_size
      case @state
      when :initial
        CONTINUATION_SIZE
      when :metadata_length
        METADATA_LENGTH_SIZE
      when :metadata
        @metadata_length
      when :body
        @body_length
      when :eos
        0
      end
    end

    def eos?
      @state == :eos
    end

    def consume(chunk)
      return if eos?

      if @buffer.size.zero?
        target = chunk
      else
        @buffer.resize(@buffer.size + chunk.size)
        @buffer.copy(chunk)
        target = @buffer
      end

      loop do
        next_size = next_required_size
        break if next_size.zero?

        if target.size < next_size
          @buffer.resize(target.size) if @buffer.size < target.size
          @buffer.copy(target)
          @buffer.resize(target.size)
          return
        end

        case @state
        when :initial
          consume_initial(target)
        when :metadata_length
          consume_metadata_length(target)
        when :metadata
          consume_metadata(target)
        when :body
          consume_body(target)
        end
        break if target.size == next_size

        target = target.slice(next_size)
      end
    end

    private
    def consume_initial(target)
      continuation = target.get_value(CONTINUATION_TYPE, 0)
      unless continuation == CONTINUATION_INT32
        raise ReadError.new("Invalid continuation token: " +
                            continuation.inspect)
      end
      @state = :metadata_length
    end

    def consume_metadata_length(target)
      length = target.get_value(METADATA_LENGTH_TYPE, 0)
      if length < 0
        raise ReadError.new("Negative metadata length: " +
                            length.inspect)
      end
      if length == 0
        @state = :eos
      else
        @metadata_length = length
        @state = :metadata
      end
    end

    def consume_metadata(target)
      metadata_buffer = target.slice(0, @metadata_length)
      @message = Org::Apache::Arrow::Flatbuf::Message.new(metadata_buffer)
      @body_length = @message.body_length
      if @body_length < 0
        raise ReadError.new("Negative body length: " +
                            @body_length.inspect)
      end
      @state = :body
      consume_body if @body_length.zero?
    end

    def consume_body(target=nil)
      body = target&.slice(0, @body_length)
      @on_read.call(@message, body)
      @state = :initial
    end
  end

  class StreamingPullReader
    include Readable

    attr_reader :schema
    def initialize(&on_read)
      @on_read = on_read
      @message_pull_reader = MessagePullReader.new do |message, body|
        process_message(message, body)
      end
      @state = :schema
      @schema = nil
      @dictionaries = nil
      @dictionary_fields = nil
    end

    def next_required_size
      @message_pull_reader.next_required_size
    end

    def eos?
      @message_pull_reader.eos?
    end

    def consume(chunk)
      @message_pull_reader.consume(chunk)
    end

    private
    def process_message(message, body)
      case @state
      when :schema
        process_schema_message(message, body)
      when :initial_dictionaries
        header = message.header
        unless header.is_a?(Org::Apache::Arrow::Flatbuf::DictionaryBatch)
          raise ReadError.new("Not a dictionary batch message: " +
                              header.inspect)
        end
        process_dictionary_batch_message(message, body)
        if @dictionaries.size == @dictionary_fields.size
          @state = :data
        end
      when :data
        case message.header
        when Org::Apache::Arrow::Flatbuf::DictionaryBatch
          process_dictionary_batch_message(message, body)
        when Org::Apache::Arrow::Flatbuf::RecordBatch
          process_record_batch_message(message, body)
        end
      end
    end

    def process_schema_message(message, body)
      header = message.header
      unless header.is_a?(Org::Apache::Arrow::Flatbuf::Schema)
        raise ReadError.new("Not a schema message: " +
                            header.inspect)
      end

      @schema = read_schema(header)
      @dictionaries = {}
      @dictionary_fields = {}
      @schema.fields.each do |field|
        next unless field.type.is_a?(DictionaryType)
        @dictionary_fields[field.dictionary_id] = field
      end
      if @dictionaries.size < @dictionary_fields.size
        @state = :initial_dictionaries
      else
        @state = :data
      end
    end

    def process_dictionary_batch_message(message, body)
      header = message.header
      if @state == :initial_dictionaries and header.delta?
        raise ReadError.new("An initial dictionary batch message must be " +
                            "a non delta dictionary batch message: " +
                            header.inspect)
      end
      field = @dictionary_fields[header.id]
      value_type = field.type.value_type
      schema = Schema.new([Field.new("dummy", value_type, true, nil)])
      record_batch = read_record_batch(header.data, schema, body)
      if header.delta?
        @dictionaries[header.id] << record_batch.columns[0]
      else
        @dictionaries[header.id] = [record_batch.columns[0]]
      end
    end

    def find_dictionary(id)
      @dictionaries[id]
    end

    def process_record_batch_message(message, body)
      header = message.header
      @on_read.call(read_record_batch(header, @schema, body))
    end
  end
end