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

継承:

オブジェクト

オブジェクト
Mongo::Grid::File::Info

すべて表示

定義:: build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb

Overview

非推奨。

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

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

以来

2.0.0

定数の概要の削減

コレクション = ファイルコレクションの名前。 以来 2.0.0

'files'.freeze

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

{
  :chunk_size => :chunkSize,
  :content_type => :contentType,
  :filename => :filename,
  :_id => :_id,
  :md 5 => :md 5,
  :Length => :Length,
  :metadata => :metadata,
  :upload_date => :uploadDate,
  :aliases => :aliases
}.freeze

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

' binary/octet-stream '.freeze

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

#document ⇒ BSON::Document readOnly

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

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

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

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

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

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

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

ファイル情報からファイル名を取得します。
#id ⇒ BSON::ObjectId

ファイル情報からファイル ID を取得します。
#初期化（ドキュメント） = 情報コンストラクター

新しいファイル情報ドキュメントを作成します。
詳しくは、を 検査しますstring

オブジェクトの読み取り可能な検査を取得します。
やでは整数（また : サイズ）

ドキュメントの長さをバイト単位で取得します。
# md 5 string 非推奨 非推奨。

2.6.0における
#metadata ⇒ String

ファイル情報ドキュメントから追加のメタデータを取得します。
# to_bson （バッファ = BSON::Byteバッファ.new、validation_keys = nil） = string

ストレージ用にファイル情報ドキュメントを BSON に変換します。
#update_md5(bytes) ⇒ Digest::MD5 非推奨 非推奨。

2.6.0における
#アップロード_日付～時間

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

コンストラクターの詳細

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

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

例:

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

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

パラメーター:

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

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

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行139

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

インスタンス属性の詳細

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

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

次の値を返します。

（ BSON::Document ） —

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

以来

2.0.0



56
57
58

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行56

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

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

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

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

例:

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

file_info == other

パラメーター:

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

確認するオブジェクト。

次の値を返します。

（ true 、 false ） —

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

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行68

デフォルト ==(その他)
  return false ただし、 その他.is_a?(info)
  ドキュメント == その他.ドキュメント
end

#bson_type ⇒ `Integer`

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

例:

BSON type を取得します。

file_info.bson_type

次の値を返します。

(整数) —

BSON type。

以来

2.0.0



81
82
83

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行81

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

#chunk_size ⇒ `Integer`

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

例:

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

file_info.chunk_size

次の値を返します。

(整数) —

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

以来

2.0.0



93
94
95

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行93

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

#content_type = `string`

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

例:

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

file_info.content_type

次の値を返します。

( string ) —

コンテンツの種類。

以来

2.0.0



105
106
107

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行105

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

#ファイル名= `string`

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

例:

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

file_info.filename

次の値を返します。

( string ) —

ファイル名。

以来

2.0.0



115
116
117

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行115

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

#id ⇒ `BSON::ObjectId`

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

例:

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

file_info.id

次の値を返します。

（ BSON::ObjectId ） —

ファイル ID。

以来

2.0.0



127
128
129

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行127

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

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

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

例:

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

file_info.inspect

次の値を返します。

( string ) —

便利な検査。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行158

デフォルト 検査する
  " #< 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



171
172
173

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行171

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

# md 5 `string`

非推奨。

2.6.0における

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

例:

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

file_info.md5

次の値を返します。

( string ) —

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

以来

2.0.0



198
199
200

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行198

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

#metadata ⇒ `String`

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

例:

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

file_info.metadata

次の値を返します。

( string ) —

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

以来

2.0.0



184
185
186

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行184

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

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

注：

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

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

例:

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

file_info.to_bson

パラメーター:

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

追加するエンコードされた BSON バッファ。
validation_keys （ true 、 false ） （デフォルトはnil ） —

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

次の値を返します。

( string ) —

未加工の BSON データ。

以来

2.0.0

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行236

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



217
218
219

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行217

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

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

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

例:

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

file_info.upload_date

次の値を返します。

（時間） —

アップロード日。

以来

2.0.0



251
252
253

ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/ Grid/file/info.rb ', 行251

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

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

Overview

定数の概要の削減

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

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

コンストラクターの詳細

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

インスタンス属性の詳細

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

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

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

#bson_type ⇒ Integer

#chunk_size ⇒ Integer

#content_type = string

#ファイル名= string

#id ⇒ BSON::ObjectId

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

長さ～整数別名:サイズ

# md 5 string

#metadata ⇒ String

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

#update_md5(bytes) ⇒ Digest::MD5

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

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

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

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

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

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

#bson_type ⇒ `Integer`

#chunk_size ⇒ `Integer`

#content_type = `string`

#ファイル名= `string`

#id ⇒ `BSON::ObjectId`

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

長さ～`整数`別名:サイズ

# md 5 `string`

#metadata ⇒ `String`

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

#update_md5(bytes) ⇒ `Digest::MD5`

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