类：Mongo::Grid::FSBucket::Stream::Write

继承：
对象
  • 对象
显示全部
定义于：
lib/ Mongo/grid/ 流/ 写入.rb

Overview

将文件写入 FSBucket 的流。

由于：

  • 2.1.0

实例属性摘要折叠

实例方法摘要折叠

构造函数详情

#initialize (fs, options) ⇒写入

创建用于将文件写入 FSBucket 的流。

例子：

创建流。

Stream::Write.new(fs, options)

参数：

  • fs ( FSBucket ) —

    GridFS 存储桶对象。

  • 选项 (哈希) —

    写入流选项。

  • opts (哈希) —

    一组可自定义的选项

选项哈希 ( options )：

  • :file_id （对象） —

    文件ID。 如果未提供文件ID，则会生成 ObjectId。

  • :write （哈希） —

    已弃用。 相当于 :write_concern 选项。

  • :write_concern （哈希） —

    写关注（write concern）选项。 可以是 :w => 整数|字符串、: fsync => 布尔值、:j => 布尔值。

由于：

  • 2.1.0



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 67

def 初始化(fs, 选项)
  @fs = fs
  @length = 0
  @n = 0
  @file_id = 选项[:file_id] || BSON::ObjectId.new
  @options = 选项.dup
  # WriteConcern对象支持
  # if @options[:write_concern].is_a?(WriteConcern::Base)
  # # 缓存实例，以便我们不会不必要地重建它。
  # @write_concern = @options[:write_concern]
  # @options[:write_concern] = @write_concern.options
  #             end
  @options.冻结
  @filename = @options[:filename]
  @open = true
  @timeout_holder = CsotTimeoutHolder.new(
    operation_timeups: {
      operation_timeout_ms： 选项[:timeout_ms],
      embedded_timeout_ms: fs.database.timeout_ms
    }
  )
end

实例属性详细信息

# file_id ⇒对象（只读）

返回 file_id 正在上传的文件的 ID。

返回：

  • ( Object ) —

    file_id 正在上传的文件的 ID。

由于：

  • 2.1.0



33
34
35
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 33

def file_id
  @file_id
end

# filename ⇒ string (readonly)

返回 filename 正在上传的文件的名称。

返回：

  • ( string ) —

    filename 正在上传的文件的名称。

由于：

  • 2.1.0



38
39
40
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 38

def 文件名
  @filename
end

# fs ⇒ FSBucket （只读）

返回 fs 该流写入的 fs 存储桶。

返回：

  • ( FSBucket ) —

    fs 此流写入的 fs 存储桶。

由于：

  • 2.1.0



28
29
30
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 28

def fs
  @fs
end

# options ⇒哈希（只读）

返回 options 写入流选项。

返回：

  • (哈希) —

    options 写入流选项。

由于：

  • 2.1.0



43
44
45
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 43

def 选项
  @options
end

实例方法详细信息

# abort ⇒ true

删除所有已插入的数据段，中止上传。

例子：

中止写入操作。

stream.abort

返回：

  • ( true ) —

    如果操作已中止且流已关闭，则为 True。

由于：

  • 2.1.0



178
179
180
181
182
183
184
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 178

def 中止
  fs.chunks_collection.find(
    { files_id: file_id },
    @options.合并(merge)(timeout_ms: @timeout_holder.剩余超时毫秒！)
  ).delete_many
  (@open = false) || true
end

# close ⇒ BSON::ObjectId , Object

关闭写入流。

例子：

关闭流。

stream.close

返回：

  • ( BSON::ObjectId , Object ) —

    文件 ID。

引发：

由于：

  • 2.1.0



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 131

def 关闭
  确保_open！
  update_length
  files_collection.insert_one(
    file_info,
    @options.合并(merge)(timeout_ms: @timeout_holder.剩余超时毫秒！)
  )
  @open = false
  file_id
end

#已关闭？ ⇒ true , false

流是否已关闭。

例子：

流是否已关闭。

stream.closed?

返回：

  • ( true , false ) —

    流是否已关闭。

由于：

  • 2.1.0



166
167
168
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 166

def 已关闭？
  !@open
end

# write (io) ⇒ Stream::Write

从流或string写入GridFS存储桶。

例子：

写入GridFS。

stream.write(io)

参数：

  • io ( string | IO ) —

    要从中上传的string或 IO 对象。

返回：

由于：

  • 2.1.0



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 100

def 写(io)
  确保_open！
  @indexes ||= ensure_indexes!
  @length += if io.respond_to?(:bytesize)
               # string对象
               io.bytesize
             else
               # IO 对象
               io.size
             end
  数据块 = file::数据块.拆分(io, file_info, @n)
  @n += 数据块.size
  除非 数据块.空？
    chunks_collection.insert_many(
      数据块,
      timeout_ms: @timeout_holder.剩余超时毫秒！
    )
  end
  self
end

# write_concern ⇒ Mongo::WriteConcern

获取上传时使用的写关注（write concern）。

例子：

获取写关注（write concern）。

stream.write_concern

返回：

由于：

  • 2.1.0



150
151
152
153
154
155
156
 
# File 'lib/ Mongo/grid/ 流/ 写入.rb', line 150

def write_concern
  @write_concern ||= if wco = @options[:write_concern] || @options[:write]
                       writeConcern.获取(wco)
                     else
                       fs.write_concern
                     end
end