クラス: Mongo::Grid::File::Info非推奨

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/grid/file/info.rb

Overview

非推奨。

代わりに、FS バケットで「ストリーム」 API を使用してください。ドライバー バージョン 3.0 で削除されます。

GridFS ファイル コレクション ファイル ドキュメント の動作をカプセル化します。

以来

  • 2.0.0

定数の概要の削減

コレクション =

ファイル コレクションの名前。

以来

  • 2.0.0

'ファイル'
マッピング =

ユーザーが提供したフィールドを db 仕様にマッピングします。

以来

  • 2.0.0

{
  chunk_size: :chunkSize,
  content_type: :contentType,
  ファイル名: :filename,
  _id: :_id,
  md5: :md 5,
  長さ： :Length,
  metadata: :metadata,
  アップロード_日付: :uploadDate,
  aliases: :aliases
}.freeze
DEFAULT_CONTENT_Type =

保存されたファイルのデフォルトのコンテンツタイプ。

以来

  • 2.0.0

'binary/octet-stream'

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化（ドキュメント） =情報

新しいファイル情報ドキュメントを作成します。

例:

新しいファイル情報ドキュメントを作成します。

Info.new(:filename => 'test.txt')

パラメーター:

  • ドキュメント （ BSON::Document ） —

    作成元となるドキュメント。

以来

  • 2.0.0



137
138
139
140
141
142
143
144
145
146
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、137 行

デフォルト 初期化(ドキュメント)
  @client_md 5 = ダイジェスト::MD5.新着情報 ただし、 ドキュメント[:disable_md 5] == true
  ユーザーオプションとキーが追加されたドキュメントが混在しているため
  セッションなどのドライバーによる内部処理。
  # ドライバーによって追加されるキーは削除しますが、ユーザー オプションは保持されます。
  ドキュメント = ドキュメント.拒否 行う |キー, _value|
    キー.to_s == 'session'
  end
  @document = default_document.merge(オプション::マッパー.transform(ドキュメント, mappings))
end

インスタンス属性の詳細

#ドキュメント= BSON::Document (読み取り専用)

ドキュメントを返します。ファイル コレクションのドキュメント。

次の値を返します。

  • （ BSON::Document ） —

    ドキュメント ファイル コレクションのドキュメント。

以来

  • 2.0.0



53
54
55
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、53 行

デフォルト ドキュメント
  @document
end

インスタンス メソッドの詳細

# == (その他) === (その他) ==================================================================================

このファイル情報ドキュメントは別のファイル情報ドキュメントと等しいか？

例:

ファイル情報ドキュメントの等価性を確認します。

file_info == other

パラメーター:

  • その他 （オブジェクト） —

    確認するオブジェクト。

次の値を返します。

  • （ true 、 false ） —

    オブジェクトが等しい場合。

以来

  • 2.0.0



65
66
67
68
69
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、65 行

デフォルト ==(その他)
  return false ただし、 その他.is_a?(info)

  ドキュメント == その他.ドキュメント
end

#bson_type ⇒ Integer

ファイル情報ドキュメントの BSON 型を取得します。

例:

BSON type を取得します。

file_info.bson_type

次の値を返します。

  • (整数) —

    BSON type。

以来

  • 2.0.0



79
80
81
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、79 行

デフォルト bson_type
  BSON::ハッシュ::BSON_TYPE
end

#chunk_size ⇒ Integer

ファイル チャンク サイズを取得します。

例:

チャンク サイズを取得します。

file_info.chunk_size

次の値を返します。

  • (整数) —

    バイト単位での チャンクサイズ 。

以来

  • 2.0.0



91
92
93
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、91 行

デフォルト chunk_size
  ドキュメント[:chunkSize]
end

#content_type = string

ファイル情報のコンテンツ タイプを取得します。

例:

コンテンツ タイプを取得します。

file_info.content_type

次の値を返します。

  • ( string ) —

    コンテンツの種類。

以来

  • 2.0.0



103
104
105
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、103 行

デフォルト content_type
  ドキュメント[:contentType]
end

#ファイル名= string

ファイル情報からファイル名を取得します。

例:

ファイル名を取得します。

file_info.filename

次の値を返します。

  • ( string ) —

    ファイル名。

以来

  • 2.0.0



113
114
115
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、113 行

デフォルト ファイル名
  ドキュメント[:filename]
end

#id ⇒ BSON::ObjectId

ファイル情報からファイル ID を取得します。

例:

ファイル ID を取得します。

file_info.id

次の値を返します。

  • （ BSON::ObjectId ） —

    ファイル ID。

以来

  • 2.0.0



125
126
127
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、125 行

デフォルト id
  ドキュメント[:_id]
end

詳しくは、 を 検査しstring ます

オブジェクトの読み取り可能な検査を取得します。

例:

ファイル情報を調べます。

file_info.inspect

次の値を返します。

  • ( string ) —

    便利な検査。

以来

  • 2.0.0



156
157
158
159
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、156 行

デフォルト 検査する
  " #< Mongo::Grid::File::Info: 0 x #{ object_id } chunk_size= #{ chunk_size } " +
    "filename=#{filename} content_type=#{content_type} id=#{id} md5=#{md5}>"
end

長さ～整数別名:サイズ

ドキュメントの長さをバイト単位で取得します。

例:

ファイル情報ドキュメントからファイル長を取得します。

file_info.length

次の値を返します。

  • (整数) —

    ファイルの長さ。

以来

  • 2.0.0



169
170
171
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、169 行

デフォルト Length
  ドキュメント[:Length]
end

# md 5 string

非推奨。

2.6.0における

md 5ハッシュを取得します。

例:

md 5ハッシュを取得します。

file_info.md5

次の値を返します。

  • ( string ) —

    md 5は string としてハッシュされます。

以来

  • 2.0.0



196
197
198
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、196 行

デフォルト md5
  ドキュメント[:md 5] || @client_md 5
end

#metadata ⇒ String

ファイル情報ドキュメントから追加のメタデータを取得します。

例:

追加のメタデータを取得します。

file_info.metadata

次の値を返します。

  • ( string ) —

    ファイル情報ドキュメントからの追加メタデータ。

以来

  • 2.0.0



182
183
184
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、182 行

デフォルト metadata
  ドキュメント[:metadata]
end

# to_bson（バッファ = BSON::Byteバッファ.new,_validation_keys = nil）=nil）============================================

注：

ファイル情報ドキュメントに md 5が存在しない場合（サーバーから読み込まれたものであり、新しいファイルではない）、md 5をダイジェスト化して設定します。

ストレージ用にファイル情報ドキュメントを BSON に変換します。

例:

ファイル情報ドキュメントを BSON に変換する。

file_info.to_bson

パラメーター:

  • バッファ （ BSON::Byteバッファ） （デフォルトはBSON::Byteバッファ.new ） —

    追加するエンコードされた BSON バッファ。

  • validation_keys （ true 、 false ） —

    直列化の際にキーを検証する必要があるかどうか。 このオプションは非推奨であり、使用されません。 バージョン3.0で削除されます。

次の値を返します。

  • ( string ) —

    未加工の BSON データ。

以来

  • 2.0.0



234
235
236
237
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、234 行

デフォルト to_bson(バッファ = BSON::Byteバッファ.新着情報, _validation_keys = nil)
  ドキュメント[:md 5] = @client_md 5.16進数 場合 @client_md 5 & & !ドキュメント[:md 5]
  ドキュメント.to_bson(バッファ)
end

#update_md5(bytes) ⇒ Digest::MD5

非推奨。

2.6.0における

注：

このメソッドは過渡的なものであり、下位互換性のために提供されています。

md 5ハッシュがある場合は更新します。

これは、md 5のサポートが完全に非推奨になると削除されます。

例:

md 5ハッシュを更新します。

file_info.update_md5(bytes)

パラメーター:

  • バイト ( string ) —

    ダイジェストを更新するために使用するバイト。

次の値を返します。

  • （ダイジェスト::MD 5 ） —

    は md 5ハッシュ オブジェクトです。

以来

  • 2.6.0



215
216
217
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、215 行

デフォルト update_md5(バイト)
  md5.update(バイト) 場合 md5
end

#アップロード_日付 ～時間

アップロード日を取得します。

例:

アップロード日を取得します。

file_info.upload_date

次の値を返します。

  • （時間） —

    アップロード日。

以来

  • 2.0.0



247
248
249
 
# ファイル 'lib/mongo/ Grid/ファイル/info.rb' は、247 行

デフォルト アップロード_date
  ドキュメント[:uploadDate]
end