Dynamic Fields

Dynamic fields are those which are not explicitly defined, but are created during indexing based on some criteria, such as a prefix or suffix on the field name. For example, a data set may have a number of fields which end in "_b". Using dynamicField functionality in Solr, it's possible to add the content of those fields to the index without having to specify each one of them in the schema.xml file. The Dynamic Fields API allows for accessing, modifying, or adding dynamic field definitions to a Collection schema.

Dynamic fields cannot be used for faceting, highlighting, de-duplication, or MoreLikeThis, unlike explicit fields. However, a dynamic field can be converted to a explicit field with the Fields API, at which point those attributes can be enabled and the field used for those features.

By default, LucidWorks Search includes a dynamic field declaration of *. This rule allows the LucidWorks Search crawlers to add fields as needed while processing crawled documents. If not using the crawlers, or are sure of how documents will be parsed by the crawlers, this rule could be removed. See also Customizing the Field Schema for more information on default dynamic rules.

API Entry Points

/api/collections/collection/dynamicfields: get all dynamic fields and their attributes for a collection or create a new dynamic field.

/api/collections/collection/dynamicfields/name: update, delete, or get details for a particular dynamic field.

Get a List of Dynamic Fields and Attributes for a Collection

GET /api/collections/collection/dynamicfields

Input

Path Parameters

Query Parameters

None.

Output

Output Content

Return Codes

200: OK

404: Not Found

Examples

Get a list of all dynamic fields for the default LucidWorks collection "collection1":

Input

curl http://localhost:8888/api/collections/collection1/dynamicfields

Output

[
{
	"field_type":"string",
	"multi_valued":true,
	"indexed":true,
	"name":"attr_*",
	"term_vectors":false,
	"index_for_spellcheck":false,
	"index_for_autocomplete":false,
	"omit_tf":true,
	"stored":true,
	"copy_fields":[ ],
	"omit_positions":true
},
{
	"field_type":"date",
	"multi_valued":false,
	"indexed":true,
	"name":"*_dt",
	"term_vectors":false,
	"index_for_spellcheck":false,
	"index_for_autocomplete":false,
	"omit_tf":true,
	"stored":true,
	"copy_fields":[ ],
	"omit_positions":true
}
]

Back to Top

Create a New Dynamic Field

POST /api/collections/collection/dynamicfields

Input

Path Parameters

Query Parameters

None.

Input Content

JSON block with one or more field attribute key/value pairs.

When creating a new dynamic field rule, the default values of some attributes are inherited from the field_type specified when the rule is created. These exceptions are noted below.

Output

Output Content

JSON representation of the created dynamic field.

Return Codes

201: Created

422: Unprocessable Entity

This error may have several different conditions:

• Name must be specified
• You must specify a field_type for the field
• A field already exists with the same name

Examples

Input

curl -H 'Content-type: application/json' -d
   {
	"name":"*_sh",
	"indexed":true,
	"stored":true,
	"field_type":"text_en"
   }' http://localhost:8888/api/collections/collection1/dynamicfields

Output

{
	"field_type":"text_en",
	"multi_valued":false,
	"indexed":true,
	"name":"*_sh",
	"term_vectors":false,
	"index_for_spellcheck":false,
	"index_for_autocomplete":false,
	"omit_tf":false,
	"stored":true,
	"copy_fields":[ ],
	"omit_positions":false
}

Back to Top

Get Attributes for a Dynamic Field

GET /api/collections/collection/dynamicfields/name

Input

Path Parameters

Query Parameters

None.

Input Content

None.

Output

Output Content

A JSON map of keys to values. For a list of keys, see GET: Output Content.

Return Codes

204: No Content

404: Not Found

Examples

Input

curl http://localhost:8888/api/collections/collection1/dynamicfields/attr_*

Output

{
	"field_type":"string",
	"multi_valued":true,
	"indexed":true,
	"name":"attr_*",
	"term_vectors":false,
	"index_for_spellcheck":false,
	"index_for_autocomplete":false,
	"omit_tf":true,
	"stored":true,
	"copy_fields":[ ],
	"omit_positions":true
}

Back to Top

Update a Dynamic Field

PUT /api/collections/collection/dynamicfields/name

Input

Path Parameters

Query Parameters

None.

Input Content

JSON block with one or more key to value mappings. Any keys you don't edit will keep their existing values. For a list of keys, see POST: Input Content

Output

Output Content

None.

Return Codes

204: No Content

404: Not Found

Examples

Edit the "attr_*" dynamic field so that it is multi-valued:

Input

curl -X PUT -H 'Content-type: application/json'
   -d '{"multi_valued":true}' 
   http://localhost:8888/api/collections/collection1/dynamicfields/attr_*

Output

None. (Check the dynamic field properties to confirm changes.)

Back to Top

Delete a Field

DELETE /api/collections/collection/dynamicfields/name

Note that deleting a field only removes it as an option for new documents; existing documents will retain this field, even after it's been deleted. Also, listing all fields in the collection will still show the field after it's been deleted.

Input

Path Parameters

Query Parameters

none

Input content

None

Output

Output Content

None

Return Codes

204: No Content

404: Not Found

Examples

Delete the "*_sh" dynamic field.

Input

curl -X DELETE http://localhost:8888/api/collections/collection1/dynamicfields/*_sh

Output

None.

Back to Top

Fields

Collections

Filtering Results