Module: Hyrax::CustomQueries

Defined in:
app/services/hyrax/custom_queries.rb,
app/services/hyrax/custom_queries/find_count_by.rb,
app/services/hyrax/custom_queries/find_ids_by_model.rb,
app/services/hyrax/custom_queries/find_by_date_range.rb,
app/services/hyrax/custom_queries/find_file_metadata.rb,
app/services/hyrax/custom_queries/find_access_control.rb,
app/services/hyrax/custom_queries/find_models_by_access.rb,
app/services/hyrax/custom_queries/navigators/find_files.rb,
app/services/hyrax/custom_queries/find_collections_by_type.rb,
app/services/hyrax/custom_queries/find_many_by_alternate_ids.rb,
app/services/hyrax/custom_queries/navigators/collection_members.rb,
app/services/hyrax/custom_queries/navigators/child_works_navigator.rb,
app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb,
app/services/hyrax/custom_queries/navigators/child_filesets_navigator.rb,
app/services/hyrax/custom_queries/navigators/child_file_sets_navigator.rb,
app/services/hyrax/custom_queries/navigators/child_collections_navigator.rb,
app/services/hyrax/custom_queries/navigators/parent_collections_navigator.rb

Overview

These custom queries are used throughout the Hyrax codebase. They are intended for use with Valkyrie’s custom query interface (i.e. you shouldn’t call classes in this namespace directly except to configure that interface).

In this namespace, we provide default/reference implementations, with the restriction that they cannot use any adapter-specific knowledge. I.e. these queries use the Valkyrie core queries and client side data manipulation only. This restriction limits performance expectations for these implementations, but guarantees a basic level of compatibility for all conforming Valkyrie adapters.

In order for a Valkyrie adapter to be “supported” by Hyrax, these queries should be individually evaluated for performance when using the adapter. Where appropriate, optimized implementations should be provided taking advantage of backend-specific query features.

See Also:

Defined Under Namespace

Modules: Navigators Classes: FindAccessControl, FindByDateRange, FindCollectionsByType, FindCountBy, FindFileMetadata, FindIdsByModel, FindManyByAlternateIds, FindModelsByAccess