ark::catalog::CatalogQuery

Defined in header “ark/catalog/search.hh”.


This is returned from parsing a search string, and is a structured set of ’things’ to query the catalog on.

Methods

  • bool operator==(const CatalogQuery & other)
    Comparator for testing.

Variables

  • std::vector< std::string > keywords
    Keywords that should be blank-searched for everywhere.

  • AttributeQueryRuleGroup primary_rule_group
    Attribute key/value pairs that should be matched. These are all of the rules that are not actually in a formal group.

  • std::vector< AttributeQueryRuleGroup > rule_groups
    Groups of attribute key/value pairs that should be matched.

  • std::vector< TimeQueryRule > time_query_rules
    List of time query rules to apply (if any).

  • std::string artifact_type
    The artifact type to match (if any).

  • std::string sort_type
    The column to sort on (if any).

  • uint64_t per_batch_limit= 0
    The limit to apply (to limit the number of results). Overrides anything coming from the API.

  • core::Guid collection_id{}
    The collection identifier, if any.

  • int64_t collection_version= -1
    The collection version to search within, if any.

  • ScheduledRemovalLogVisibility scheduled_for_removal_visibility= ScheduledRemovalLogVisibility::Hidden
    If we should show scheduled-for-removal logs or not.

  • bool successful_jobs_only= false
    Search for matches where all jobs are successful.

  • bool failed_jobs_only= false
    Search for only jobs that had a failure.

  • bool running_jobs_only= false
    Search for jobs that are still running.