模块：Mongoid

扩展方式：: Forwardable、 Mongoid 、 Clients::Sessions::ClassMethods 、 Deprecable 、 GlobalDiscriminatorKeyAssignment 、 Loadable 、 Loggable

包含在：: Mongoid

定义于：: lib/mongoid.rb 、 lib/mongoid/utils.rb、 lib/mongoid/atomic.rb、 lib/mongoid/config.rb、 lib/mongoid/fields.rb、 lib/mongoid/clients.rb、 lib/mongoid/ factory.rb、lib/mongoid/matcher.rb、lib/mongoid/version.rb、lib/mongoid/copyable.rb、lib/mongoid/criteria.rb、lib/mongoid/ 文档、lib/mongoid/equality.rb rb、lib/mongoid/findable.rb、lib/mongoid/loadable.rb、lib/mongoid/loggable.rb、lib/mongoid/scopable.rb、lib/mongoid/stateful.rb、 lib/mongoid/warnings.rb, lib/mongoid/cacheable.rb, lib/mongoid/evolvable.rb, lib/mongoid/indexable.rb, lib/mongoid/matchable.rb, lib/mongoid/shardable.rb, lib/ mongoid/touchable.rb、 lib/mongoid/attributes.rb、 lib/mongoid/changeable.rb、 lib/mongoid/composable.rb、 lib/mongoid/contextual.rb、 lib/mongoid/deprecable.rb、 lib/mongoid/ matcher/eq.rb、lib/mongoid/matcher/gt.rb、lib/mongoid/matcher/in.rb、lib/mongoid/matcher/lt.rb、lib/mongoid/matcher/ne.rb、lib/mongoid/ matcher/or.rb、lib/mongoid/positional.rb、lib/mongoid/reloadable.rb、lib/mongoid/ selectable.rb、lib/mongoid/timestamps.rb、lib/mongoid/association.rb、lib/mongoid/deprecation.rb、lib/mongoid/encryptable.rb、lib/mongoid/matcher/all.rb、lib/mongoid/ matcher/and.rb、lib/mongoid/matcher/gte.rb、lib/mongoid/matcher/lte.rb、lib/mongoid/matcher/mod.rb、lib/mongoid/matcher/nin.rb、lib/mongoid/ matcher/nor.rb、 lib/mongoid/matcher/not.rb、 lib/mongoid/persistable.rb、 lib/mongoid/traversable.rb、 lib/mongoid/validatable.rb、 lib/mongoid/identifier.rb、 lib/ mongoid/matcher/bits.rb、 lib/mongoid/matcher/size.rb、 lib/mongoid/matcher/type.rb、 lib/mongoid/serializable.rb、 lib/mongoid/interceptable.rb、 lib/mongoid/matcher/ regex.rb、lib/mongoid/config/options.rb、lib/mongoid/extensions/ 设立、lib/mongoid/matcher/exists.rb、lib/mongoid/model_resolver.rb、lib/mongoid/tasks/ 数据库。 rb、lib/mongoid/association/one.rb、lib/mongoid/clients/factory.rb、lib/mongoid/clients/options.rb、lib/mongoid/config/defaults.rb、lib/mongoid/contextual/none。 rb, lib/mongoid/errors/ 回调.rb, lib/mong oid/errors/ 回滚.rb、 lib/mongoid/extensions/date.rb、 lib/mongoid/extensions/hash.rb、 lib/mongoid/extensions/time.rb、 lib/mongoid/fields/standard.rb、 lib/ mongoid/matcher/eq_impl.rb、 lib/mongoid/association/many.rb、 lib/mongoid/atomic/modifiers.rb、 lib/mongoid/clients/sessions.rb、 lib/mongoid/contextual/ Mongo.rb、 lib/ mongoid/criteria/options.rb, lib/mongoid/errors/no_parent.rb, lib/mongoid/extensions/ 大量.rb, lib/mongoid/extensions/float.rb, lib/mongoid/extensions/ 范围.rb, lib/ mongoid/fields/ 加密、lib/mongoid/fields/localized.rb、lib/mongoid/search_indexable.rb、lib/mongoid/tasks/ 加密、lib/mongoid/timestamps/short.rb、lib/mongoid/ Association/eager.rb、lib/mongoid/association/proxy.rb、lib/mongoid/atomic/paths/root.rb、lib/mongoid/attributes/nested.rb、lib/mongoid/config/ 加密、lib/ mongoid/contextual/atomic.rb, lib/mongoid/contextual/memory.rb, lib/mongoid/criteria/findable.rb, lib/mongoid/criteria/scopable.rb, lib/mongoid/extensions/binary.rb, lib/mongoid/extensions/module.rb、 lib/mongoid/extensions/ 对象.rb、 lib/mongoid/extensions/regexp.rb、 lib/mongoid/extensions/string.rb、 lib/mongoid/extensions/symbol.rb、 lib/mongoid/association/macros.rb、 lib/mongoid/association/nested.rb、 lib/mongoid/attributes/dynamic.rb、 lib/mongoid/config/environment.rb、 lib/mongoid/contextual/command.rb、 lib/mongoid/criteria/queryable.rb、 lib/mongoid/errors/no_metadata.rb、 lib/mongoid/errors/validations.rb、 lib/mongoid/extensions/boolean.rb、 lib/mongoid/extensions/integer.rb、 lib/mongoid/fields/foreign_key.rb, lib/mongoid/matcher/elem_match.rb, lib/mongoid/matcher/ 表达式.rb, lib/mongoid/stringified_symbol.rb, lib/mongoid/threaded/lifecycle.rb, lib/ mongoid/timestamps/created.rb, lib/mongoid/timestamps/updated.rb, lib/mongoid/validatable/format.rb, lib/mongoid/validatable/length.rb, lib/mongoid/validatable/macros.rb, lib/ mongoid/association/options.rb、lib/mongoid/attributes/embedded.rb、lib/mongoid/attributes/readonly.rb、lib/mongoid/criter ia/includable.rb、 lib/mongoid/criteria/modifier.rb、 lib/mongoid/criteria/permission.rb、 lib/mongoid/criteria/translator.rb、 lib/mongoid/errors/invalid_find.rb、 lib/mongoid/ errors/invalid_path.rb、lib/mongoid/errors/invalid_time.rb、lib/mongoid/persistable/logic.rb、lib/mongoid/persistable/maxable.rb、lib/mongoid/persistable/minable.rb、lib/mongoid/ persistable/savable.rb、lib/mongoid/persistence_context.rb、lib/mongoid/timestamps/timeless.rb、lib/mongoid/association/bindable.rb、lib/mongoid/association/ 构建者、lib/mongoid/attributes/投影仪.rb、 lib/mongoid/contextual/queryable.rb、 lib/mongoid/criteria/marshalable.rb、 lib/mongoid/errors/invalid_field.rb、 lib/mongoid/errors/invalid_index.rb、 lib/mongoid/errors/ invalid_query.rb、lib/mongoid/errors/invalid_scope.rb、lib/mongoid/errors/mongoid_error.rb、lib/mongoid/errors/unknown_model.rb、lib/mongoid/extensions/date_time.rb、lib/mongoid/extensions/ nil_class.rb、lib/mongoid/extensions/object_id.rb、lib/mongoid/extensions/raw_val ue.rb、 lib/mongoid/matcher/bits_all_set.rb、 lib/mongoid/matcher/bits_any_set.rb、 lib/mongoid/persistable/poppable.rb、 lib/mongoid/persistable/pullable.rb、 lib/mongoid/persistable/ pushable.rb、lib/mongoid/persistable/settable.rb、lib/mongoid/validatable/presence.rb、lib/mongoid/association/accessors.rb、lib/mongoid/association/depending.rb、lib/mongoid/association/ relatable.rb、 lib/mongoid/atomic/paths/embedded.rb、 lib/mongoid/attributes/ 处理、 lib/mongoid/contextual/aggregable.rb、 lib/mongoid/contextual/map_reduce.rb、 lib/mongoid/ errors/no_environment.rb、lib/mongoid/extensions/decimal128.rb、lib/mongoid/extensions/true_class.rb、lib/mongoid/persistable/creatable.rb、lib/mongoid/persistable/deletable.rb、lib /mongoid/persistable/renameable.rb, lib/mongoid/persistable/updatable.rb, lib/mongoid/validatable/queryable.rb, lib/mongoid/association/nested/one.rb, lib/mongoid/atomic_update_preparer.rb, lib /mongoid/criteria/queryable/key.rb, lib/mongoid/errors/invalid_options.rb, lib/mo ngoid/errors/mixed_relations.rb, lib/mongoid/errors/no_client_hosts.rb, lib/mongoid/errors/scope_overwrite.rb, lib/mongoid/extensions/big_decimal.rb, lib/mongoid/extensions/false_class.rb, lib/ mongoid/matcher/bits_all_clear.rb, lib/mongoid/matcher/bits_any_clear.rb, lib/mongoid/matcher/field_operator.rb, lib/mongoid/persistable/unsettable.rb, lib/mongoid/persistable/upsertable.rb, lib/ mongoid/validatable/association.rb、 lib/mongoid/validatable/uniqueness.rb、 lib/mongoid/association/marshalable.rb、 lib/mongoid/association/nested/many.rb、 lib/mongoid/association/reflections.rb、 lib/mongoid/clients/storage_options.rb、 lib/mongoid/collection_configurable.rb、 lib/mongoid/errors/invalid_includes.rb、 lib/mongoid/errors/invalid_relation.rb、 lib/mongoid/errors/no_client_config.rb、 lib/ mongoid/errors/unsaved_document.rb, lib/mongoid/fields/validators/macro.rb, lib/mongoid/persistable/destroyable.rb, lib/mongoid/validatable/localizable.rb, lib/mongoid/config/validators/ 客户端。 rb, lib/mongoid/con无花果/验证器/选项。 lib/mongoid/errors/no_default_client.rb、 lib/mongoid/errors/readonly_document.rb、 lib/mongoid/errors/transaction_error.rb、 lib/mongoid/errors/unknown_attribute.rb、 lib/mongoid/matcher/field_expression.rb、 lib/mongoid/persistable/multipliable.rb, lib/mongoid/timestamps/created/short.rb, lib/mongoid/timestamps/updated/short.rb, lib/mongoid/validatable/numericality.rb, lib/mongoid/association/ constrainable.rb, lib/mongoid/atomic/paths/embedded/one.rb, lib/mongoid/errors/delete_restriction.rb, lib/mongoid/errors/document_not_Found.rb, lib/mongoid/errors/invalid_collection.rb, lib/ mongoid/errors/invalid_field_type.rb, lib/mongoid/errors/no_client_database.rb, lib/mongoid/errors/readonly_attribute.rb, lib/mongoid/errors/unregistered_class.rb, lib/mongoid/extensions/time_with_zone.rb, lib/ mongoid/persistab le/incrementable.rb、lib/mongoid/association/eager_loadable.rb、lib/mongoid/association/embedded/eager.rb、lib/mongoid/atomic/paths/embedded/many.rb、lib/mongoid/clients/validators/ 存储.rb、 lib/mongoid/contextual/aggregable/none.rb、 lib/mongoid/criteria/queryable/options.rb、 lib/mongoid/errors/immutable_attribute.rb、 lib/mongoid/errors/invalid_config_file.rb、 lib/ Rails/generators/mongoid_generator.rb, lib/mongoid/association/embedded/Circular.rb, lib/mongoid/contextual/aggregable/ Mongo.rb, lib/mongoid/criteria/queryable/Optional.rb, lib/mongoid/criteria/ Queryable/ 管道.rb、 lib/mongoid/criteria/queryable/selector.rb、 lib/mongoid/criteria/queryable/storable.rb、 lib/mongoid/errors/attribute_not_loaded.rb、 lib/mongoid/errors/invalid_field_option.rb、 lib/mongoid/errors/no_map_reduce_output.rb、lib/mongoid/matcher/eq_impl_with_regexp.rb、lib/mongoid/matcher/expression_operator.rb、lib/mongoid/railties/controller_runtime.rb、lib/mongoid/contextual/aggregable/memory. rb, lib/mongoid/c riteria/queryable/macroable.rb、lib/mongoid/criteria/queryable/mergeable.rb、lib/mongoid/errors/invalid_config_option.rb、lib/mongoid/errors/unrecognized_resolver.rb、lib/mongoid/indexable/validators/options。 rb, lib/mongoid/criteria/queryable/aggregable.rb, lib/mongoid/criteria/queryable/expandable.rb, lib/mongoid/criteria/queryable/selectable.rb, lib/mongoid/errors/ambiguous_relationship.rb, lib/ mongoid/errors/document_not_destroyed.rb, lib/mongoid/errors/invalid_field_operator.rb, lib/mongoid/errors/sessions_not_supported.rb, lib/mongoid/errors/unsupported_javascript.rb, lib/mongoid/matcher/elem_match_expression.rb, lib/ mongoid/association/embedded/batchable.rb、lib/mongoid/association/referenced/has_one.rb、lib/mongoid/errors/drop_collection_failure.rb、lib/mongoid/errors/invalid_round_callback.rb、lib/mongoid/errors/invalid_relation_option。 rb, lib/mongoid/errors/invalid_session_nesting.rb, lib/mongoid/errors/invalid_storage_options.rb, lib/mongoid/association/embedded/embeds_one.r b, lib/mongoid/association/referenced/has_many.rb, lib/mongoid/association/referenced/syncable.rb, lib/mongoid/errors/unrecognized_model_alias.rb, lib/mongoid/association/embedded/embedded_in.rb, lib/ mongoid/association/embedded/embeds_many.rb, lib/mongoid/association/referenced/auto_save.rb, lib/mongoid/errors/create_collection_failure.rb, lib/mongoid/association/referenced/belongs_to.rb, lib/mongoid/contextual/ Mongo/documents_loader.rb、 lib/mongoid/criteria/queryable/extensions/ 设立.rb、 lib/mongoid/errors/criteria_argument_required.rb、 lib/mongoid/errors/invalid_depend_strategy.rb、 lib/mongoid/errors/invalid_persistence_option.rb、 lib/mongoid/errors/mixed_client_configuration.rb, lib/mongoid/errors/transactions_not_supported.rb, lib/mongoid/criteria/queryable/extensions/date.rb, lib/mongoid/criteria/queryable/extensions/hash.rb, lib/ mongoid/criteria/queryable/extensions/time.rb, lib/mongoid/errors/invalid_elem_match_operator.rb, lib/mongoid/errors/invalid_expression_operator.rb 、 lib/mongoid/errors/invalid_transaction_nesting.rb、 lib/mongoid/railties/bson_object_id_serializer.rb、 lib/mongoid/association/nested/nested_buildable.rb、 lib/mongoid/criteria/queryable/extensions/ 大量.rb、 lib/mongoid /criteria/queryable/extensions/ 范围.rb, lib/mongoid/errors/invalid_async_query_executor.rb, lib/mongoid/association/referenced/counter_cache.rb, lib/mongoid/association/referenced/has_one/eager.rb, lib/mongoid /association/referenced/has_one/proxy.rb, lib/mongoid/criteria/queryable/extensions/ 对象.rb, lib/mongoid/criteria/queryable/extensions/regexp.rb, lib/mongoid/criteria/queryable/extensions/string 。 /eager.rb, lib/mongoid/association/referenced/has_many/proxy.rb, lib/mongoid/criteria/queryable/extensions/boolean.rb, lib/mongoid/criteria/queryable/extensions/ numeric.rb, lib/mongoid/association/embedded/embedded_in/proxy.rb, lib/mongoid/association/embedded/embeds_many/proxy.rb, lib/mongoid/association/referenced/has_one/ Binding.rb, lib/mongoid/ config/validators/async_query_executor.rb, lib/mongoid/errors/invalid_estimated_count_scoping.rb, lib/rails/generators/mongoid/model/model_generator.rb, lib/mongoid/association/embedded/embeds_one/bounding.rb, lib/mongoid/ Association/referenced/belongs_to/eager.rb、lib/mongoid/association/referenced/belongs_to/proxy.rb、lib/mongoid/association/referenced/has_many/ Binding.rb、lib/mongoid/criteria/queryable/extensions/date_time。 rb, lib/mongoid/criteria/queryable/extensions/nil_class.rb, lib/mongoid/errors/invalid_discriminator_key_target.rb, lib/mongoid/errors/invalid_estimated_count_criteria.rb, lib/mongoid/errors/invalid_set_polymorphic_relation.rb, lib/mongoid/ Association/embedded/embedded_in/ Binding.rb, lib/mongoid/association/embedded/embeds_many/ Binding.rb, lib/mongoid/association/referenced/has_o ne/buildable.rb, lib/mongoid/errors/in_memory_collation_not_supported.rb, lib/mongoid/errors/too_many_nested_attribute_records.rb, lib/rails/generators/mongoid/config/config_generator.rb, lib/mongoid/association/embedded/embeds_one/构建。 Association/embedded/embedded_in/buildable.rb, lib/mongoid/association/embedded/embeds_many/buildable.rb, lib/mongoid/association/referenced/has_many/enumerable.rb, lib/mongoid/errors/invalid_global_executor_concurrency.rb, lib/ mongoid/association/referenced/belongs_to/buildable.rb, lib/mongoid/errors/nested_attributes_metadata_not_Found.rb, lib/mongoid/criteria/queryable/extensions/time_with_zone.rb, lib/mongoid/errors/invalid_auto_encryption_configuration.rb, lib/mongoid/ Association/referenced/has_and_belongs_to_many.rb, lib/mongoid/association/referenced/with _poly态_criteria.rb, lib/mongoid/association/referenced/has_and_belongs_to_many/eager.rb, lib/mongoid/association/referenced/has_and_belongs_to_many/proxy.rb, lib/mongoid/association/referenced/has_and_belongs_to_many/bounding.rb, lib/mongoid/ Association/referenced/has_and_belongs_to_many/buildable.rb

Overview

rubocop:todo all

在命名空间下定义

模块： 关联、原子、属性、可缓存、可更改、客户端、CollectionConfigurable、可组合、配置、上下文、可复制、可弃用、文档、可加密、相等、错误、可演进、扩展、工厂、字段、可查找、生成器、GlobalDiscriminatorKeyAssignment、可识别、可索引、 Interceptable 、 Loadable 、 Loggable 、 Matchable 、 Matcher 、 Persistable 、Positional 、 Railties 、 Reloadable 、 scopable 、 SearchIndexable 、 Selectable 、 Serializable 、 Shardable 、 Stateful 、 Tasks 、 Threaded 、 Timestamps 、 Touchable 、 Traversable 、 Utils 、 Validatable 、WARNINGS 类：AtomicUpdatePreparer 、 Boolean 、 Criteria 、弃用、 ModelResolver 、 PersistenceContext 、 RawValue 、 StringifiedSymbol

常量摘要折叠

PLATFORM_DETAILS = string添加到Ruby 驾驶员客户端握手文档的平台详细信息的。

" mongoid- #{ VERSION } ".冻结

MONGODB_VERSION = 支持的最低MongoDB版本。

"2.6.0"

VERSION = 当前版本的 Mongoid 请注意，此文件通过“rake候选：创建”自动更新。对该文件的手动更改将被该 rake任务覆盖。

'9.0.7'

包含在Loadable中的常量

Loadable::DEFAULT_IGNORE_PATTERNS 、 Loadable::DEFAULT_MODEL_PATHS

Clients::Sessions::ClassMethods 中包含的常量

Clients::Sessions::ClassMethods::CALLBACK_ACTIONS

实例方法摘要折叠

# 客户端 (name) ⇒ Mongo::Client

获取命名客户端的便捷方法。
#configure(&block) ⇒ Config

设置 Mongoid 配置选项。
# default_client ⇒ Mongo::Client

获取默认客户端的便捷方法。
#disconnect_clients ⇒ true

断开所有活动客户端的连接。
#persistence_context ⇒ 对象 private

定义在 Mongoid 模块上调用ACID 事务方法时使用的持久性上下文。
# RawValue (*args) ⇒ Mongoid::RawValue

实例化一个新的 Mongoid::RawValue对象。
# reconnect_clients ⇒ true

重新连接所有活动客户端。
# storage_options ⇒ 对象 private

定义在 Mongoid 模块上调用ACID 事务方法时使用的客户端。

实例方法详细信息

# 客户端 (name) ⇒ `Mongo::Client`

获取命名客户端的便捷方法。

例子：

获取命名客户端。

Mongoid.client(:default)

( Mongo::Client ) —

已命名的客户端。



119
120
121

# File 'lib/mongoid.rb', 第119行

def 客户端(名称)
  客户端.with_name(名称)
end

# configure (&B) ⇒`配置`

设置 Mongoid 配置选项。最好通过传递一个区块来使用。

例子：

设置配置选项。

Mongoid.configure do |config|
  config.connect_to("mongoid_test")

  config.clients.default = {
    hosts: ["localhost:27017"],
    database: "mongoid_test",
  }
end

使用不带参数的区块。在内部使用 'config'

the block to perform variable assignment.

Mongoid.configure do
  connect_to("mongoid_test")

  config.preload_models = true

(配置) —

配置对象。

# File 'lib/mongoid.rb', 第77行

def 配置(和块)
  return 配置 除非 block_given?

  块.元数 == 0 ? 配置.instance_exec(和块) : 产量(配置)
end

# default_client ⇒ `Mongo::Client`

获取默认客户端的便捷方法。

例子：

获取默认客户端。

Mongoid.default_client

( Mongo::Client ) —

默认客户端。



89
90
91

# File 'lib/mongoid.rb', 第89行

def default_client
  客户端.访问
end

#disconnect_clients ⇒ `true`

断开所有活动客户端的连接。

例子：

断开所有活动客户端的连接。

Mongoid.disconnect_clients

( true ) —

是的。



99
100
101

# File 'lib/mongoid.rb', 第99行

def connect_clients
  客户端.断开连接
end

#persistence_context ⇒`对象`

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

定义在 Mongoid 模块上调用ACID 事务方法时使用的持久性上下文。



134
135
136

# File 'lib/mongoid.rb', 第134行

def persistence_context
  PersistenceContext.获取(Mongoid) || PersistenceContext.new(Mongoid)
end

# RawValue (*args) ⇒ `Mongoid::RawValue`

实例化一个新的 Mongoid::RawValue对象。用作语法快捷方式。

例子：

创建 Mongoid::RawValue对象。

Mongoid::RawValue("Beagle")

( Mongoid::RawValue ) —

对象。



13
14
15

# File 'lib/mongoid/extensions/raw_value.rb', line 13

def RawValue(*args)
  RawValue.new(*args)
end

# reconnect_clients ⇒ `true`

重新连接所有活动客户端。

例子：

重新连接所有活动客户端。

Mongoid.reconnect_clients

( true ) —

是的。



109
110
111

# File 'lib/mongoid.rb', 第109行

def reconnect_clients
  客户端.重新连接
end

# storage_options ⇒`对象`

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

定义在 Mongoid 模块上调用ACID 事务方法时使用的客户端。这必须是默认客户端。



142
143
144

# File 'lib/mongoid.rb', 第142行

def storage_options
  { 客户端: :default }
end

模块：Mongoid

Overview

在命名空间下定义

常量摘要折叠

包含在Loadable中的常量

Clients::Sessions::ClassMethods 中包含的常量

实例方法摘要折叠

Loggable中包含的方法

Loadable中包含的方法

Clients::Sessions::ClassMethods 中包含的方法

GlobalDiscriminatorKeyAssignment 中包含的方法

包含在Deprecable 中的方法

实例方法详细信息

# 客户端 (name) ⇒ Mongo::Client

例子：

获取命名客户端。

# configure (&B) ⇒配置

例子：

设置配置选项。

使用不带参数的区块。 在内部使用 'config'

# default_client ⇒ Mongo::Client

例子：

获取默认客户端。

#disconnect_clients ⇒ true

例子：

断开所有活动客户端的连接。

#persistence_context ⇒对象

# RawValue (*args) ⇒ Mongoid::RawValue

例子：

创建 Mongoid::RawValue对象。

# reconnect_clients ⇒ true

例子：

重新连接所有活动客户端。

# storage_options ⇒对象

# 客户端 (name) ⇒ `Mongo::Client`

# configure (&B) ⇒`配置`

使用不带参数的区块。在内部使用 'config'

# default_client ⇒ `Mongo::Client`

#disconnect_clients ⇒ `true`

#persistence_context ⇒`对象`

# RawValue (*args) ⇒ `Mongoid::RawValue`

# reconnect_clients ⇒ `true`

# storage_options ⇒`对象`