Storefront API

# Database tool

Storefront API provides you with unified tooling for managing embedded Elastic Schema. This tool lets you create new indexes or apply modified index mappings to exisiting ones. ElasticSchema is provided on the modules level.

# The need for a database tool

After more extensive data operations, like custom imports using mage2vuestorefront or magento1-vsbridge, there is a need to reindex the ElasticSearch and set up the proper metadata for fields.

The main reason you’ll know you must reindex the database is the following error you get from the storefront-api console:

Error: {"root_cause":[{"type":"illegal_argument_exception","reason":"Fielddata is disabled on text fields by default. Set fielddata=true on [created_at] in order to load fielddata in memory by uninverting the inverted index. Note that this can however use significant memory. Alternatively use a keyword field instead."}],"type":"search_phase_execution_exception","reason":"all shards failed","phase":"query","grouped":true,"failed_shards":[{"shard":0,"index":"vue_storefront_catalog_1521776807","node":"xIOeZW2lTwaprGXh6YLyCA","reason":{"type":"illegal_argument_exception","reason":"Fielddata is disabled on text fields by default. Set fielddata=true on [created_at] in order to load fielddata in memory by uninverting the inverted index. Note that this can however use significant memory. Alternatively use a keyword field instead."}}]}

In this case, there is a db tool inside your local storefront-api installation to the rescue.

# Re-indexing an existing database

Please go to the storefront-api directory and run:

docker exec -it sfa_app_1 yarn db7 rebuild

This command will:

  • Reindex your currently set (in the config/local.json config file) Elasticsearch index to a temporary one,
  • Put the right Elasticsearch mappings on top of the temporary index,
  • Drop the original index,
  • Create an alias with the original name to the temporary one so you can use the original name without any reference changes.

You can specify an index name different to the one set in config/local.json by running:

docker exec -it sfa_app_1 yarn db7 rebuild -- --indexName=custom_index_name

# Creating the a new index

If you want to create a new, empty index, please run:

docker exec -it sfa_app_1 yarn db7 new

This tool will drop your current index and create a new, empty one with all the metafields set.

You can specify an index name different to the one set in config/local.json by running:

docker exec -it sfa_app_1 yarn db7 rebuild -- --indexName=custom_index_name

# Changing the index structure / adding new fields / changing the types

If you want to extend the Elasticsearch data structures or map some particular field types, for example, after getting kind of this error:

[{"type":"illegal_argument_exception","reason":"Fielddata is disabled on text fields by default. Set fielddata=true on [created_at] in order to load fielddata in memory by uninverting the inverted index. Note that this can however use significant memory. Alternatively use a keyword field instead."}]

Please change the ES schema by modifying the schema provided by a particular module.

The format is compliant with ES DSL for schema modifications.

After the changes, run the following indexing command:

docker exec -it sfa_app_1 yarn db7 rebuild

←