Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move action-and-meta-data to (indexing) type definition #312

Closed
danielmitterdorfer opened this issue Aug 4, 2017 · 0 comments
Closed

Move action-and-meta-data to (indexing) type definition #312

danielmitterdorfer opened this issue Aug 4, 2017 · 0 comments
Labels
breaking Non-backwards compatible change enhancement Improves the status quo :Track Management New operations, changes in the track format, track download changes and the like
Milestone

Comments

@danielmitterdorfer
Copy link
Member

danielmitterdorfer commented Aug 4, 2017

Today, the action-and-meta-data property, which describes how to treat a source file w.r.t. to that line for bulk indexing, has to be set on the bulk-index operation. However, it is actually a property of the source file itself. Hence, we should move this property to the source file definition.

This change will break existing tracks if a user has defined this property on the bulk-index operation. As this is not a very common use case and the migration is rather simple, we go down that route.

Steps to migrate

In case you get the following error when running a benchmark you need to migrate your track:

The parameter "action-and-meta-data" is not supported anymore. 
Please specify instead the boolean flag "includes-action-and-meta-data" 
on each type definition.
  1. Remove the property action-and-meta-data from the affected indexing operation.
  2. You need to add the property includes-action-and-meta-data on all types that you've defined. The value depends on the previous value of action-and-meta-data:
    2.1 If action-and-meta-data was sourcefile, set includes-action-and-meta-data to true.
    2.2 If action-and-meta-data was generate, set includes-action-and-meta-data to false.
    2.3 The mode action-and-meta-data = none is not supported anymore. If you have used it before and still need it, please raise an issue and explain your use case. The suggested migration approach is to set includes-action-and-meta-data to false and let Rally generate the action and meta-data line.
@danielmitterdorfer danielmitterdorfer added :Track Management New operations, changes in the track format, track download changes and the like enhancement Improves the status quo labels Aug 4, 2017
@danielmitterdorfer danielmitterdorfer added this to the Backlog milestone Aug 4, 2017
@danielmitterdorfer danielmitterdorfer added the breaking Non-backwards compatible change label Aug 8, 2017
@danielmitterdorfer danielmitterdorfer modified the milestones: 0.6.3, Backlog Aug 8, 2017
@danielmitterdorfer danielmitterdorfer changed the title Move action-and-meta-data to index instead of operation Move action-and-meta-data to (indexing) type definition Aug 8, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Non-backwards compatible change enhancement Improves the status quo :Track Management New operations, changes in the track format, track download changes and the like
Projects
None yet
Development

No branches or pull requests

1 participant