Solr
  1. Solr
  2. SOLR-3438

Document SolrCell's use of the meta field

    Details

      Description

      SolrCell will add document metadata to the field named "meta" if it is present in the schema. This is undocumented behavior and can be surprising and confusing to users who explicitly added a field named "meta" to their schema for their own purpose without any awareness that SolrCell would be populating it with document metadata.

      This issue merely proposes to clearly document the use of the "meta" field, but several questions do arise:

      1) Is this behavior actually intended as a released future? As opposed to some experimental work that wasn't intended for release just yet.

      2) Should there be a request parameter to be able to disable this feature?
      2a) Should the default be that this feature is enabled or disabled?

      3) Should the "meta" field be added to the example schema (the section for SolrCell metadata fields) to reinforce the fact that a user should not blindly add their own "meta" field for some other purpose?

      4) Should there be a request parameter to redirect this behavior to a named field?
      4a) Should the default name be more explicit (e.g., solrcell_metadata)?

      This issue is only intended to address documentation related to question #1. If the answers to any of the other questions are "yes", a separate issue can be opened. That said, I do lean towards adding the "meta" field to the example schema as part of the "documentation."

      For reference I'll attach a snippet from a query result that has the "meta" field populated by an extracted Word document.

      1. SolrCell meta field.xml
        2 kB
        Jack Krupansky
      2. SolrCell meta field.xml
        3 kB
        Jack Krupansky

        Activity

        Jack Krupansky created issue -
        Jack Krupansky made changes -
        Field Original Value New Value
        Attachment SolrCell meta field.xml [ 12525747 ]
        Jack Krupansky made changes -
        Summary Document SolrCells' use of the meta field Document SolrCell's use of the meta field
        Description SolrCell will add document metadata to the field named "meta" if it is present in the schema. This is undocumented behavior and can be surprising and confusing to users who explicitly added a field named "meta" to their schema for their own purpose without any awareness that SolrCell would be populating it with document metadata.

        This issue merely proposes to clearly document the use of the "meta" field, but several questions do arise:

        1) Is this behavior actually intended as a released future? As opposed to some experimental work that wasn't intended for release just yet.

        2) Should there be a request parameter to be able to disable this feature?
        2a) Should the default be to have to enabled?

        3) Should the "meta" field be added to the example schema (the section for SolrCell metadata fields) to reinforce the fact that a user should not blindly add their own "meta" field for some other purpose?

        4) Should there be a request parameter to redirect this behavior to a named field?
        4a) Should the default name be more explicit (e.g., solrcell_metadata)?

        This issue is only intended to address documentation related to question #1. If the answers to any of the other questions are "yes", a separate issue can be opened. That said, I do lean towards adding the "meta" field to the example schema as part of the "documentation."

        For reference I'll attend a snippet from a query result that has the "meta" field populated by an extracted Word document.
        SolrCell will add document metadata to the field named "meta" if it is present in the schema. This is undocumented behavior and can be surprising and confusing to users who explicitly added a field named "meta" to their schema for their own purpose without any awareness that SolrCell would be populating it with document metadata.

        This issue merely proposes to clearly document the use of the "meta" field, but several questions do arise:

        1) Is this behavior actually intended as a released future? As opposed to some experimental work that wasn't intended for release just yet.

        2) Should there be a request parameter to be able to disable this feature?
        2a) Should the default be that this feature is enabled or disabled?

        3) Should the "meta" field be added to the example schema (the section for SolrCell metadata fields) to reinforce the fact that a user should not blindly add their own "meta" field for some other purpose?

        4) Should there be a request parameter to redirect this behavior to a named field?
        4a) Should the default name be more explicit (e.g., solrcell_metadata)?

        This issue is only intended to address documentation related to question #1. If the answers to any of the other questions are "yes", a separate issue can be opened. That said, I do lean towards adding the "meta" field to the example schema as part of the "documentation."

        For reference I'll attach a snippet from a query result that has the "meta" field populated by an extracted Word document.
        Jack Krupansky made changes -
        Attachment SolrCell meta field.xml [ 12525748 ]

          People

          • Assignee:
            Unassigned
            Reporter:
            Jack Krupansky
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:

              Development