モジュール: Mongoid::Config

次による拡張機能。
転送可能、構成、デフォルト、オプション
次のことが含まれます。
DeprecationOptions
次のドキュメントに含まれます。
Config
定義:
build/mongoid- 8.1 /lib/mongoid/config.rb 、
build/mongoid- 8.1 /lib/mongoid/config/options.rb、
build/mongoid- 8.1 /lib/mongoid/config/defaults.rb、
build/mongoid- 8.1 /lib/mongoid/config/environment.rb、
build/mongoid- 8 . 1 /lib/mongoid/config/validator/client.rb、
build/mongoid- 8 . 1 /lib/mongoid/config/validator/option.rb、
build/mongoid- 8 . 1 /lib/mongoid/config/validator/async_query_executor.rb

Overview

このモジュールは、データベース接続を含む Mongoid のすべての構成オプションを定義します。

名前空間で定義済み

Modules: デフォルト、 DeprecationOptions 、 environment 、オプション、バリデーター

定数の概要の削減

LOCK = 
ミューテックス.新着情報

DeprecationOptionsから含まれる定数

DeprecationOptions::OPTIONS

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

オプションに含まれるメソッド

defaults 、 log_level 、オプション、リセット、設定

Default に含まれるメソッド

load_defaults

DeprecationOptionsに含まれるメソッド

先頭

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

クライアント=ハッシュ

クライアント構成または空のハッシュを取得します。

例:

クライアント構成を取得します。

config.clients

次の値を返します。

  • （ハッシュ） —

    クライアント構成。



373
374
375
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行373

デフォルト クライアント
  @clients ||= {}
end

#config ⇒ self

DSL で使用する Config 単一の を返します。

次の値を返します。

  • （自己） —

    Config シングルボタン。



191
192
193
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行191

デフォルト config
  自己
end

構成済みの数 = true | false

Mongoid は設定されましたか。 これは、少なくとも有効なクライアント構成が存在することをチェックしています。

例:

Mongoid は構成されていますか？

config.configured?

次の値を返します。

  • （ true | false ） —

    Mongoid が構成されている場合。



202
203
204
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行202

デフォルト 構成されているかどうか
  クライアント.key?(:default)
end

# connect_to （名前、オプション = {read: {mode: :primary }} = {read: {mode: :primary }} =オブジェクト

注：

便宜上、開発環境またはテスト環境でのみ使用してください。

デフォルトのクライアントで指定されたデータベース名に接続します。

例:

接続するデータベースを設定します。

config.connect_to("mongoid_test")

パラメーター:

  • name ( string ) —

    データベース名。



214
215
216
217
218
219
220
221
222
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行214

デフォルト connect_to(name, options = { read: { モード: : プライマリ }})
  自己.クライアント = {
    デフォルト:  {
      database: name,
      ホスト: [ "localhost:27017" ],
      次のオプションがあります。 options
    }
  }
end

#deregister_model(klass) ⇒ Object

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Mongoid を使用してアプリケーション内のモデルの登録を解除します。

パラメーター:

  • klass （クラス） —

    登録解除するモデル。



281
282
283
284
285
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行281

デフォルト delete_model(klass)
  ロック.同期 行う
    モデル.削除(klass)
  end
end

#destructive_fields = 配列=string=string===================<String>

Mongoid::Document で定義されている場合に破壊的な結果が発生する可能性のあるフィールド名を返します。

例:

破壊的なフィールドを取得します。

config.destructive_fields

次の値を返します。

  • （ <String>配列未満

    無効なフィールド名の配列。



231
232
233
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行231

デフォルト delivery_fields
  構成可能.禁止_メソッド
end

#負荷。 (path, environment = nil) = nil) =オブジェクト

準拠の mongoid.yML ファイルから設定をロードします。 これは Rails 以外のフレームワークで簡単に設定するために使用できます。

例:

Mongoid を構成します。

Mongoid.load!("/path/to/mongoid.yml")

パラメーター:

  • path ( string ) —

    ファイルへのパス。

  • environment （ string | Symbol ） （デフォルトはnil ） —

    ロードする環境。



243
244
245
246
247
248
249
250
251
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行243

デフォルト ロードします。(path, environment = nil)
  設定 = environment.load_YAML(path, environment)
  場合 設定.存在するかどうか
    クライアント.切断
    クライアント.クリア
    load_configuration(設定)
  end
  設定
end

# load_configuration (settings) =オブジェクト

設定のハッシュから、すべての構成をロードします。

例:

構成をロードします。

config.load_configuration(settings)

パラメーター:

  • 設定 （ハッシュ） —

    構成設定。



293
294
295
296
297
298
299
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行293

デフォルト load_configuration(設定)
  構成 = 設定.with_in distinct_access
  自己.options = 構成[:options]
  自己.クライアント = 構成[:clients]
  mongo.options = 構成[:Driver_options] || {}
  set_log_levels
end

#models ⇒ Array<Class>

アプリケーション内のすべてのモデルを取得します。これは Mongoid::Document を含むすべてです。

例:

すべてのモデルを取得します。

config.models

次の値を返します。

  • （ <Class>配列 ） —

    アプリケーション内のすべてのモデル。



260
261
262
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行260

デフォルト モデル
  @models ||= []
end

#オプション= （オプション） ===================================

構成オプション を設定します。 それぞれを個別に検証します。

例:

オプションを設定します。

config.options = { raise_not_found_error: true }

パラメーター:

  • options （ハッシュ） —

    構成オプション。



357
358
359
360
361
362
363
364
365
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行357

デフォルト options=(options)
  場合 options
    バリデーター::AsyncQueryExecutor.validate(options)
    options.each_pair 行う |オプション, 価値|
      バリデーター::オプション.validate(オプション)
      送信(" #{オプション} = ", 価値)
    end
  end
end

# overwrite_client (name) = string | Symbol

グローバルに使用するクライアントを上書きします。

例:

クライアントをグローバルに上書きします。

config.override_client(:optional)

パラメーター:

  • name ( string | Symbol ) —

    クライアントの名前。

次の値を返します。

  • ( string | Symbol ) —

    グローバル オーバーライド。



321
322
323
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行321

デフォルト overwrite_client(name)
  スレッド.client_ overwrite = name ? name.to_s : nil
end

# overwrite_database (name) = string | Symbol

グローバルに使用するデータベースを上書きします。

例:

データベースをグローバルに上書きします。

config.override_database(:optional)

パラメーター:

  • name ( string | Symbol ) —

    データベースの名前。

次の値を返します。

  • ( string | Symbol ) —

    グローバル オーバーライド。



309
310
311
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行309

デフォルト override_database(name)
  スレッド.database_override = name
end

#消去します。 = true

注：

これはすべてのデータを削除する最速の方法です。

インデックスを含むすべてのコレクション内のすべてのデータを消去します。

例:

すべてのデータを消去します。

Mongoid::Config.purge!

次の値を返します。

  • ( true ) —

    true。



333
334
335
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行333

デフォルト 消去します。
  global_client.database.collections.各(&:drop) および true
end

#register_model(klass) ⇒ Object

Mongoid を使用してアプリケーションにモデルを登録します。

例:

モデルを登録します。

config.register_model(Band)

パラメーター:

  • klass （クラス） —

    登録するモデル。



270
271
272
273
274
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行270

デフォルト register_model(klass)
  ロック.同期 行う
    モデル.プッシュ(klass) ただし、 モデル.include?(klass)
  end
end

# Running_with_passager は? = true | false

アプリケーションはカスタマーで実行されていますか？

例:

アプリケーションは乗用者を使用していますか。

config.running_with_passenger?

次の値を返します。

  • （ true | false ） —

    アプリがpass際に配置されている場合。



393
394
395
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行393

デフォルト Running_with_passager
  @ Running_with_passager ||= 定義済み?(PlusionPassager)
end

#time_zone ⇒ String

使用するタイムゾーンを取得します。

例:

タイム ゾーンを取得します。

Config.time_zone

次の値を返します。

  • ( string ) —

    タイムゾーン。



383
384
385
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行383

デフォルト time_zone
  use_utc? ? " UTC " : ::時間.ゾーン
end

#を切り捨てます。 = true

注：

これはパージよりも遅くなります。

インデックスは除くすべてのコレクション内のすべてのデータを切り捨てます。

例:

すべてのコレクション データを切り捨てます。

Mongoid::Config.truncate!

次の値を返します。

  • ( true ) —

    true。



345
346
347
348
349
 
次のファイル「Build/mongoid- 8.1 /lib/mongoid/config.rb」の行345

デフォルト 切り捨てます。
  global_client.database.collections.各 行う |コレクション|
    コレクション.find.delete_many
  end および true
end