API Docs

Search engine API.

class invenio_search.api.BaseRecordsSearch(**kwargs)

Example subclass for searching records using Elastic DSL.

Use Meta to set kwargs defaults.

class Meta

Configuration for Search and FacetedSearch classes.

default_filter = None

Default filter added to search body.

Example: default_filter = DefaultFilter('_access.owner:"1"').

classmethod faceted_search(query=None, filters=None, search=None)

Return faceted search instance with defaults set.

Parameters:

• query – Elastic DSL query object (Q).
• filters – Dictionary with selected facet values.
• search – An instance of Search class. (default: cls()).

get_record(id_)

Return a record by its identifier.

Parameters:id – The record identifier. Returns:The record.

get_records(ids)

Return records by their identifiers.

Parameters:ids – A list of record identifier. Returns:A list of records.

with_preference_param()

Add the preference param to the ES request and return a new Search.

The preference param avoids the bouncing effect with multiple replicas, documented on ES documentation. See: https://www.elastic.co/guide/en/elasticsearch/guide/current /_search_options.html#_preference for more information.

class invenio_search.api.BaseRecordsSearchV2(fields=('*', ), default_filter=None, **kwargs)

Base records search V2.

Sets the needed args in kwargs for the search.

get_record(id_)

Return a record by its identifier.

Parameters:id – The record identifier. Returns:The record.

get_records(ids)

Return records by their identifiers.

Parameters:ids – A list of record identifier. Returns:A list of records.

with_preference_param(preference)

Add the preference param to the ES request and return a new Search.

The preference param avoids the bouncing effect with multiple replicas, documented on ES documentation. See: https://www.elastic.co/guide/en/elasticsearch/guide/current /_search_options.html#_preference for more information.

Parameters:preference – A function that returns the preference value.

class invenio_search.api.DefaultFilter(query=None, query_parser=None)

Shortcut for defining default filters with query parser.

Build filter property with query parser.

query

Build lazy query if needed.

class invenio_search.api.MinShouldMatch

Work-around for Elasticsearch DSL problem.

The ElasticSearch DSL Bool query tries to inspect the minimum_should_match parameter, but understands only integers and not queries like “0<1”. This class circumvents the specific problematic clause in Elasticsearch DSL.

class invenio_search.api.PrefixedIndexList

Custom list type for avoiding double prefixing.

class invenio_search.api.PrefixedSearchMixin

Mixing to use index prefixing.

prefix_index(index)

Using PrefixedIndexList type to avoid double prefixing.

class invenio_search.api.RecordsSearch(**kwargs)

Prefixed record search class.

Constructor.

class invenio_search.api.RecordsSearchV2(**kwargs)

Prefixed record search class.

Constructor.

invenio_search.api.UnPrefixedRecordsSearch

alias of invenio_search.api.BaseRecordsSearch

invenio_search.api.UnPrefixedRecordsSearchV2

alias of invenio_search.api.BaseRecordsSearchV2

Utilities

Utility functions for search engine.

invenio_search.utils.build_alias_name(index, prefix=None, app=None)

Build an alias name.

Parameters:

• index – Name of the index.
• prefix – The prefix to prepend to the index name.

invenio_search.utils.build_index_from_parts(*parts)

Build an index name from parts.

Parameters:parts – String values that will be joined by dashes (“-“).

invenio_search.utils.build_index_name(index, prefix=None, suffix=None, app=None)

Build an index name.

Parameters:

• index – Name of the index.
• prefix – The prefix to prepend to the index name.
• suffix – The suffix to append to the index name.
• app – Flask app passed to prefix_index and suffix_index.

invenio_search.utils.prefix_index(index, prefix=None, app=None)

Prefixes the given index if needed.

Parameters:

• index – Name of the index to prefix.
• prefix – Force a prefix.
• app – Flask app to get the prefix config from.

Returns:

A string with the new index name prefixed if needed.

invenio_search.utils.schema_to_index(schema, index_names=None)

Get index/doc_type given a schema URL.

Parameters:

• schema – The schema name
• index_names – A list of index name.

Returns:

A tuple containing (index, doc_type).

invenio_search.utils.suffix_index(index, suffix=None, app=None)

Suffixes the given index.

Parameters:

• index – Name of the index to prefix.
• suffix – The suffix to append to the index name.
• app – Flask app to get the “invenio-search” extension from.

Returns:

A string with the new index name suffixed.

invenio_search.utils.timestamp_suffix()

Generate a suffix based on the current time.